AWS SDK for PHP 3.x

Service ID: ssm

Version: 2014-11-06

This page describes the parameters and results for the operations of the Amazon Simple Systems Manager (SSM) (2014-11-06), and shows how to use the Aws\Ssm\SsmClient object to call the described operations. This documentation is specific to the 2014-11-06 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddTagsToResource ( array $params = [] )
Adds or overwrites one or more tags for the specified resource.
CancelCommand ( array $params = [] )
Attempts to cancel the command specified by the Command ID.
CancelMaintenanceWindowExecution ( array $params = [] )
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running.
CreateActivation ( array $params = [] )
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager.
CreateAssociation ( array $params = [] )
A State Manager association defines the state that you want to maintain on your instances.
CreateAssociationBatch ( array $params = [] )
Associates the specified Systems Manager document with the specified instances or targets.
CreateDocument ( array $params = [] )
Creates a Systems Manager (SSM) document.
CreateMaintenanceWindow ( array $params = [] )
Creates a new maintenance window.
CreateOpsItem ( array $params = [] )
Creates a new OpsItem.
CreateOpsMetadata ( array $params = [] )
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 ( array $params = [] )
Creates a patch baseline.
CreateResourceDataSync ( array $params = [] )
A resource data sync helps you view data from multiple sources in a single location.
DeleteActivation ( array $params = [] )
Deletes an activation.
DeleteAssociation ( array $params = [] )
Disassociates the specified Systems Manager document from the specified instance.
DeleteDocument ( array $params = [] )
Deletes the Systems Manager document and all instance associations to the document.
DeleteInventory ( array $params = [] )
Delete a custom inventory type or the data associated with a custom Inventory type.
DeleteMaintenanceWindow ( array $params = [] )
Deletes a maintenance window.
DeleteOpsMetadata ( array $params = [] )
Delete OpsMetadata related to an application.
DeleteParameter ( array $params = [] )
Delete a parameter from the system.
DeleteParameters ( array $params = [] )
Delete a list of parameters.
DeletePatchBaseline ( array $params = [] )
Deletes a patch baseline.
DeleteResourceDataSync ( array $params = [] )
Deletes a Resource Data Sync configuration.
DeregisterManagedInstance ( array $params = [] )
Removes the server or virtual machine from the list of registered servers.
DeregisterPatchBaselineForPatchGroup ( array $params = [] )
Removes a patch group from a patch baseline.
DeregisterTargetFromMaintenanceWindow ( array $params = [] )
Removes a target from a maintenance window.
DeregisterTaskFromMaintenanceWindow ( array $params = [] )
Removes a task from a maintenance window.
DescribeActivations ( array $params = [] )
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 ( array $params = [] )
Describes the association for the specified target or instance.
DescribeAssociationExecutionTargets ( array $params = [] )
Use this API action to view information about a specific execution of a specific association.
DescribeAssociationExecutions ( array $params = [] )
Use this API action to view all executions for a specific association ID.
DescribeAutomationExecutions ( array $params = [] )
Provides details about all active and terminated Automation executions.
DescribeAutomationStepExecutions ( array $params = [] )
Information about all active and terminated step executions in an Automation workflow.
DescribeAvailablePatches ( array $params = [] )
Lists all patches eligible to be included in a patch baseline.
DescribeDocument ( array $params = [] )
Describes the specified Systems Manager document.
DescribeDocumentPermission ( array $params = [] )
Describes the permissions for a Systems Manager document.
DescribeEffectiveInstanceAssociations ( array $params = [] )
All associations for the instance(s).
DescribeEffectivePatchesForPatchBaseline ( array $params = [] )
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
DescribeInstanceAssociationsStatus ( array $params = [] )
The status of the associations for the instance(s).
DescribeInstanceInformation ( array $params = [] )
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.
DescribeInstancePatchStates ( array $params = [] )
Retrieves the high-level patch state of one or more instances.
DescribeInstancePatchStatesForPatchGroup ( array $params = [] )
Retrieves the high-level patch state for the instances in the specified patch group.
DescribeInstancePatches ( array $params = [] )
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
DescribeInventoryDeletions ( array $params = [] )
Describes a specific delete inventory operation.
DescribeMaintenanceWindowExecutionTaskInvocations ( array $params = [] )
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
DescribeMaintenanceWindowExecutionTasks ( array $params = [] )
For a given maintenance window execution, lists the tasks that were run.
DescribeMaintenanceWindowExecutions ( array $params = [] )
Lists the executions of a maintenance window.
DescribeMaintenanceWindowSchedule ( array $params = [] )
Retrieves information about upcoming executions of a maintenance window.
DescribeMaintenanceWindowTargets ( array $params = [] )
Lists the targets registered with the maintenance window.
DescribeMaintenanceWindowTasks ( array $params = [] )
Lists the tasks in a maintenance window.
DescribeMaintenanceWindows ( array $params = [] )
Retrieves the maintenance windows in an AWS account.
DescribeMaintenanceWindowsForTarget ( array $params = [] )
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
DescribeOpsItems ( array $params = [] )
Query a set of OpsItems.
DescribeParameters ( array $params = [] )
Get information about a parameter.
DescribePatchBaselines ( array $params = [] )
Lists the patch baselines in your AWS account.
DescribePatchGroupState ( array $params = [] )
Returns high-level aggregated patch compliance state for a patch group.
DescribePatchGroups ( array $params = [] )
Lists all patch groups that have been registered with patch baselines.
DescribePatchProperties ( array $params = [] )
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches.
DescribeSessions ( array $params = [] )
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
GetAutomationExecution ( array $params = [] )
Get detailed information about a particular Automation execution.
GetCalendarState ( array $params = [] )
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time.
GetCommandInvocation ( array $params = [] )
Returns detailed information about command execution for an invocation or plugin.
GetConnectionStatus ( array $params = [] )
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
GetDefaultPatchBaseline ( array $params = [] )
Retrieves the default patch baseline.
GetDeployablePatchSnapshotForInstance ( array $params = [] )
Retrieves the current snapshot for the patch baseline the instance uses.
GetDocument ( array $params = [] )
Gets the contents of the specified Systems Manager document.
GetInventory ( array $params = [] )
Query inventory information.
GetInventorySchema ( array $params = [] )
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
GetMaintenanceWindow ( array $params = [] )
Retrieves a maintenance window.
GetMaintenanceWindowExecution ( array $params = [] )
Retrieves details about a specific a maintenance window execution.
GetMaintenanceWindowExecutionTask ( array $params = [] )
Retrieves the details about a specific task run as part of a maintenance window execution.
GetMaintenanceWindowExecutionTaskInvocation ( array $params = [] )
Retrieves information about a specific task running on a specific target.
GetMaintenanceWindowTask ( array $params = [] )
Lists the tasks in a maintenance window.
GetOpsItem ( array $params = [] )
Get information about an OpsItem by using the ID.
GetOpsMetadata ( array $params = [] )
View operational metadata related to an application in Application Manager.
GetOpsSummary ( array $params = [] )
View a summary of OpsItems based on specified filters and aggregators.
GetParameter ( array $params = [] )
Get information about a parameter by using the parameter name.
GetParameterHistory ( array $params = [] )
Retrieves the history of all changes to a parameter.
GetParameters ( array $params = [] )
Get details of a parameter.
GetParametersByPath ( array $params = [] )
Retrieve information about one or more parameters in a specific hierarchy.
GetPatchBaseline ( array $params = [] )
Retrieves information about a patch baseline.
GetPatchBaselineForPatchGroup ( array $params = [] )
Retrieves the patch baseline that should be used for the specified patch group.
GetServiceSetting ( array $params = [] )
ServiceSetting is an account-level setting for an AWS service.
LabelParameterVersion ( array $params = [] )
A parameter label is a user-defined alias to help you manage different versions of a parameter.
ListAssociationVersions ( array $params = [] )
Retrieves all versions of an association for a specific association ID.
ListAssociations ( array $params = [] )
Returns all State Manager associations in the current AWS account and Region.
ListCommandInvocations ( array $params = [] )
An invocation is copy of a command sent to a specific instance.
ListCommands ( array $params = [] )
Lists the commands requested by users of the AWS account.
ListComplianceItems ( array $params = [] )
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
ListComplianceSummaries ( array $params = [] )
Returns a summary count of compliant and non-compliant resources for a compliance type.
ListDocumentMetadataHistory ( array $params = [] )
Information about approval reviews for a version of an SSM document.
ListDocumentVersions ( array $params = [] )
List all versions for a document.
ListDocuments ( array $params = [] )
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
ListInventoryEntries ( array $params = [] )
A list of inventory items returned by the request.
ListOpsItemEvents ( array $params = [] )
Returns a list of all OpsItem events in the current AWS account and Region.
ListOpsMetadata ( array $params = [] )
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
ListResourceComplianceSummaries ( array $params = [] )
Returns a resource-level summary count.
ListResourceDataSync ( array $params = [] )
Lists your resource data sync configurations.
ListTagsForResource ( array $params = [] )
Returns a list of the tags assigned to the specified resource.
ModifyDocumentPermission ( array $params = [] )
Shares a Systems Manager document publicly or privately.
PutComplianceItems ( array $params = [] )
Registers a compliance type and other compliance details on a designated resource.
PutInventory ( array $params = [] )
Bulk update custom inventory items on one more instance.
PutParameter ( array $params = [] )
Add a parameter to the system.
RegisterDefaultPatchBaseline ( array $params = [] )
Defines the default patch baseline for the relevant operating system.
RegisterPatchBaselineForPatchGroup ( array $params = [] )
Registers a patch baseline for a patch group.
RegisterTargetWithMaintenanceWindow ( array $params = [] )
Registers a target with a maintenance window.
RegisterTaskWithMaintenanceWindow ( array $params = [] )
Adds a new task to a maintenance window.
RemoveTagsFromResource ( array $params = [] )
Removes tag keys from the specified resource.
ResetServiceSetting ( array $params = [] )
ServiceSetting is an account-level setting for an AWS service.
ResumeSession ( array $params = [] )
Reconnects a session to an instance after it has been disconnected.
SendAutomationSignal ( array $params = [] )
Sends a signal to an Automation execution to change the current behavior or status of the execution.
SendCommand ( array $params = [] )
Runs commands on one or more managed instances.
StartAssociationsOnce ( array $params = [] )
Use this API action to run an association immediately and only one time.
StartAutomationExecution ( array $params = [] )
Initiates execution of an Automation document.
StartChangeRequestExecution ( array $params = [] )
Creates a change request for Change Manager.
StartSession ( array $params = [] )
Initiates a connection to a target (for example, an instance) for a Session Manager session.
StopAutomationExecution ( array $params = [] )
Stop an Automation that is currently running.
TerminateSession ( array $params = [] )
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance.
UnlabelParameterVersion ( array $params = [] )
Remove a label or labels from a parameter.
UpdateAssociation ( array $params = [] )
Updates an association.
UpdateAssociationStatus ( array $params = [] )
Updates the status of the Systems Manager document associated with the specified instance.
UpdateDocument ( array $params = [] )
Updates one or more values for an SSM document.
UpdateDocumentDefaultVersion ( array $params = [] )
Set the default version of a document.
UpdateDocumentMetadata ( array $params = [] )
Updates information related to approval reviews for a specific version of a document.
UpdateMaintenanceWindow ( array $params = [] )
Updates an existing maintenance window.
UpdateMaintenanceWindowTarget ( array $params = [] )
Modifies the target of an existing maintenance window.
UpdateMaintenanceWindowTask ( array $params = [] )
Modifies a task assigned to a maintenance window.
UpdateManagedInstanceRole ( array $params = [] )
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM).
UpdateOpsItem ( array $params = [] )
Edit or change an OpsItem.
UpdateOpsMetadata ( array $params = [] )
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
UpdatePatchBaseline ( array $params = [] )
Modifies an existing patch baseline.
UpdateResourceDataSync ( array $params = [] )
Update a resource data sync.
UpdateServiceSetting ( array $params = [] )
ServiceSetting is an account-level setting for an AWS service.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeActivations
DescribeAssociationExecutionTargets
DescribeAssociationExecutions
DescribeAutomationExecutions
DescribeAutomationStepExecutions
DescribeAvailablePatches
DescribeEffectiveInstanceAssociations
DescribeEffectivePatchesForPatchBaseline
DescribeInstanceAssociationsStatus
DescribeInstanceInformation
DescribeInstancePatchStates
DescribeInstancePatchStatesForPatchGroup
DescribeInstancePatches
DescribeInventoryDeletions
DescribeMaintenanceWindowExecutionTaskInvocations
DescribeMaintenanceWindowExecutionTasks
DescribeMaintenanceWindowExecutions
DescribeMaintenanceWindowSchedule
DescribeMaintenanceWindowTargets
DescribeMaintenanceWindowTasks
DescribeMaintenanceWindows
DescribeMaintenanceWindowsForTarget
DescribeOpsItems
DescribeParameters
DescribePatchBaselines
DescribePatchGroups
DescribePatchProperties
DescribeSessions
GetInventory
GetInventorySchema
GetOpsSummary
GetParameterHistory
GetParametersByPath
ListAssociationVersions
ListAssociations
ListCommandInvocations
ListCommands
ListComplianceItems
ListComplianceSummaries
ListDocumentVersions
ListDocuments
ListOpsItemEvents
ListOpsMetadata
ListResourceComplianceSummaries
ListResourceDataSync

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
CommandExecuted	GetCommandInvocation	5	20

Operations

AddTagsToResource

$result = $client->addTagsToResource([/* ... */]);
$promise = $client->addTagsToResourceAsync([/* ... */]);

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.

Each resource can have a maximum of 50 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.

For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.

Parameter Syntax

$result = $client->addTagsToResource([
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => 'Document|ManagedInstance|MaintenanceWindow|Parameter|PatchBaseline|OpsItem|OpsMetadata', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceId

Required: Yes
Type: string

The resource ID you want to tag.

Use the ID of the resource. Here are some examples:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

PatchBaseline: pb-012345abcde

OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.

For the Document and Parameter values, use the name of the resource.

The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

ResourceType

Required: Yes
Type: string

Specifies the type of resource you are tagging.

The ManagedInstance type for this API action is for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Tags

Required: Yes
Type: Array of Tag structures

One or more tags. The value parameter is required.

Do not enter personally identifiable information in this field.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidResourceType:
The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.
InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.
InternalServerError:
An error occurred on the server side.
TooManyTagsError:
The Targets parameter includes too many tags. Remove one or more tags and try the command again.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.

CancelCommand

$result = $client->cancelCommand([/* ... */]);
$promise = $client->cancelCommandAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cancelCommand([
    'CommandId' => '<string>', // REQUIRED
    'InstanceIds' => ['<string>', ...],
]);

Parameter Details

Members

CommandId

Required: Yes
Type: string

The ID of the command you want to cancel.

InstanceIds

Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidCommandId:
This error does not currently have a description.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
DuplicateInstanceId:
You cannot specify an instance ID in more than one association.

CancelMaintenanceWindowExecution

$result = $client->cancelMaintenanceWindowExecution([/* ... */]);
$promise = $client->cancelMaintenanceWindowExecutionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->cancelMaintenanceWindowExecution([
    'WindowExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

WindowExecutionId

Required: Yes
Type: string

The ID of the maintenance window execution to stop.

Result Syntax

[
    'WindowExecutionId' => '<string>',
]

Result Details

Members

WindowExecutionId

Type: string

The ID of the maintenance window execution that has been stopped.

Errors

InternalServerError:
An error occurred on the server side.
DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.

CreateActivation

$result = $client->createActivation([/* ... */]);
$promise = $client->createActivationAsync([/* ... */]);

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

On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.

Parameter Syntax

$result = $client->createActivation([
    'DefaultInstanceName' => '<string>',
    'Description' => '<string>',
    'ExpirationDate' => <integer || string || DateTime>,
    'IamRole' => '<string>', // REQUIRED
    'RegistrationLimit' => <integer>,
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

DefaultInstanceName

Type: string

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Description

Type: string

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

ExpirationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

IamRole

Required: Yes
Type: string

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

RegistrationLimit

Type: int

Specify the maximum number of managed instances you want to register. The default value is 1 instance.

Tags

Type: Array of Tag structures

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

Key=OS,Value=Windows
Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Result Syntax

[
    'ActivationCode' => '<string>',
    'ActivationId' => '<string>',
]

Result Details

Members

ActivationCode

Type: string

The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.

ActivationId

Type: string

The ID number generated by the system when it processed the activation. The activation ID functions like a user name.

Errors

InternalServerError:
An error occurred on the server side.

CreateAssociation

$result = $client->createAssociation([/* ... */]);
$promise = $client->createAssociationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAssociation([
    'ApplyOnlyAtCronInterval' => true || false,
    'AssociationName' => '<string>',
    'AutomationTargetParameterName' => '<string>',
    'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
    'DocumentVersion' => '<string>',
    'InstanceId' => '<string>',
    'MaxConcurrency' => '<string>',
    'MaxErrors' => '<string>',
    'Name' => '<string>', // REQUIRED
    'OutputLocation' => [
        'S3Location' => [
            'OutputS3BucketName' => '<string>',
            'OutputS3KeyPrefix' => '<string>',
            'OutputS3Region' => '<string>',
        ],
    ],
    'Parameters' => [
        '<ParameterName>' => ['<string>', ...],
        // ...
    ],
    'ScheduleExpression' => '<string>',
    'SyncCompliance' => 'AUTO|MANUAL',
    'TargetLocations' => [
        [
            'Accounts' => ['<string>', ...],
            'ExecutionRoleName' => '<string>',
            'Regions' => ['<string>', ...],
            'TargetLocationMaxConcurrency' => '<string>',
            'TargetLocationMaxErrors' => '<string>',
        ],
        // ...
    ],
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members

ApplyOnlyAtCronInterval

Type: boolean

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.

AssociationName

Type: string

Specify a descriptive name for the association.

AutomationTargetParameterName

Type: string

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

ComplianceSeverity

Type: string

The severity level to assign to the association.

DocumentVersion

Type: string

The document version you want to associate with the target(s). Can be a specific version or the default version.

InstanceId

Type: string

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

MaxConcurrency

Type: string

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

MaxErrors

Type: string

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

Name

Required: Yes
Type: string

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

arn:partition:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

OutputLocation

Type: InstanceAssociationOutputLocation structure

An S3 bucket where you want to store the output details of the request.

Parameters

Type: Associative array of custom strings keys (ParameterName) to stringss

The parameters for the runtime configuration of the document.

ScheduleExpression

Type: string

A cron expression when the association will be applied to the target(s).

SyncCompliance

Type: string

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

TargetLocations

Type: Array of TargetLocation structures

A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

Targets

Type: Array of Target structures

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Result Syntax

[
    'AssociationDescription' => [
        'ApplyOnlyAtCronInterval' => true || false,
        'AssociationId' => '<string>',
        'AssociationName' => '<string>',
        'AssociationVersion' => '<string>',
        'AutomationTargetParameterName' => '<string>',
        'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
        'Date' => <DateTime>,
        'DocumentVersion' => '<string>',
        'InstanceId' => '<string>',
        'LastExecutionDate' => <DateTime>,
        'LastSuccessfulExecutionDate' => <DateTime>,
        'LastUpdateAssociationDate' => <DateTime>,
        'MaxConcurrency' => '<string>',
        'MaxErrors' => '<string>',
        'Name' => '<string>',
        'OutputLocation' => [
            'S3Location' => [
                'OutputS3BucketName' => '<string>',
                'OutputS3KeyPrefix' => '<string>',
                'OutputS3Region' => '<string>',
            ],
        ],
        'Overview' => [
            'AssociationStatusAggregatedCount' => [<integer>, ...],
            'DetailedStatus' => '<string>',
            'Status' => '<string>',
        ],
        'Parameters' => [
            '<ParameterName>' => ['<string>', ...],
            // ...
        ],
        'ScheduleExpression' => '<string>',
        'Status' => [
            'AdditionalInfo' => '<string>',
            'Date' => <DateTime>,
            'Message' => '<string>',
            'Name' => 'Pending|Success|Failed',
        ],
        'SyncCompliance' => 'AUTO|MANUAL',
        'TargetLocations' => [
            [
                'Accounts' => ['<string>', ...],
                'ExecutionRoleName' => '<string>',
                'Regions' => ['<string>', ...],
                'TargetLocationMaxConcurrency' => '<string>',
                'TargetLocationMaxErrors' => '<string>',
            ],
            // ...
        ],
        'Targets' => [
            [
                'Key' => '<string>',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Members

AssociationDescription

Type: AssociationDescription structure

Information about the association.

Errors

AssociationAlreadyExists:
The specified association already exists.
AssociationLimitExceeded:
You can have at most 2,000 active associations.
InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidDocumentVersion:
The document version is not valid or does not exist.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
UnsupportedPlatformType:
The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.
InvalidOutputLocation:
The output location is not valid or does not exist.
InvalidParameters:
You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.
InvalidTarget:
The target is not valid or does not exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
InvalidSchedule:
The schedule is invalid. Verify your cron or rate expression and try again.

CreateAssociationBatch

$result = $client->createAssociationBatch([/* ... */]);
$promise = $client->createAssociationBatchAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAssociationBatch([
    'Entries' => [ // REQUIRED
        [
            'ApplyOnlyAtCronInterval' => true || false,
            'AssociationName' => '<string>',
            'AutomationTargetParameterName' => '<string>',
            'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
            'DocumentVersion' => '<string>',
            'InstanceId' => '<string>',
            'MaxConcurrency' => '<string>',
            'MaxErrors' => '<string>',
            'Name' => '<string>', // REQUIRED
            'OutputLocation' => [
                'S3Location' => [
                    'OutputS3BucketName' => '<string>',
                    'OutputS3KeyPrefix' => '<string>',
                    'OutputS3Region' => '<string>',
                ],
            ],
            'Parameters' => [
                '<ParameterName>' => ['<string>', ...],
                // ...
            ],
            'ScheduleExpression' => '<string>',
            'SyncCompliance' => 'AUTO|MANUAL',
            'TargetLocations' => [
                [
                    'Accounts' => ['<string>', ...],
                    'ExecutionRoleName' => '<string>',
                    'Regions' => ['<string>', ...],
                    'TargetLocationMaxConcurrency' => '<string>',
                    'TargetLocationMaxErrors' => '<string>',
                ],
                // ...
            ],
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

Entries

Required: Yes
Type: Array of CreateAssociationBatchRequestEntry structures

One or more associations.

Result Syntax

[
    'Failed' => [
        [
            'Entry' => [
                'ApplyOnlyAtCronInterval' => true || false,
                'AssociationName' => '<string>',
                'AutomationTargetParameterName' => '<string>',
                'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
                'DocumentVersion' => '<string>',
                'InstanceId' => '<string>',
                'MaxConcurrency' => '<string>',
                'MaxErrors' => '<string>',
                'Name' => '<string>',
                'OutputLocation' => [
                    'S3Location' => [
                        'OutputS3BucketName' => '<string>',
                        'OutputS3KeyPrefix' => '<string>',
                        'OutputS3Region' => '<string>',
                    ],
                ],
                'Parameters' => [
                    '<ParameterName>' => ['<string>', ...],
                    // ...
                ],
                'ScheduleExpression' => '<string>',
                'SyncCompliance' => 'AUTO|MANUAL',
                'TargetLocations' => [
                    [
                        'Accounts' => ['<string>', ...],
                        'ExecutionRoleName' => '<string>',
                        'Regions' => ['<string>', ...],
                        'TargetLocationMaxConcurrency' => '<string>',
                        'TargetLocationMaxErrors' => '<string>',
                    ],
                    // ...
                ],
                'Targets' => [
                    [
                        'Key' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'Fault' => 'Client|Server|Unknown',
            'Message' => '<string>',
        ],
        // ...
    ],
    'Successful' => [
        [
            'ApplyOnlyAtCronInterval' => true || false,
            'AssociationId' => '<string>',
            'AssociationName' => '<string>',
            'AssociationVersion' => '<string>',
            'AutomationTargetParameterName' => '<string>',
            'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
            'Date' => <DateTime>,
            'DocumentVersion' => '<string>',
            'InstanceId' => '<string>',
            'LastExecutionDate' => <DateTime>,
            'LastSuccessfulExecutionDate' => <DateTime>,
            'LastUpdateAssociationDate' => <DateTime>,
            'MaxConcurrency' => '<string>',
            'MaxErrors' => '<string>',
            'Name' => '<string>',
            'OutputLocation' => [
                'S3Location' => [
                    'OutputS3BucketName' => '<string>',
                    'OutputS3KeyPrefix' => '<string>',
                    'OutputS3Region' => '<string>',
                ],
            ],
            'Overview' => [
                'AssociationStatusAggregatedCount' => [<integer>, ...],
                'DetailedStatus' => '<string>',
                'Status' => '<string>',
            ],
            'Parameters' => [
                '<ParameterName>' => ['<string>', ...],
                // ...
            ],
            'ScheduleExpression' => '<string>',
            'Status' => [
                'AdditionalInfo' => '<string>',
                'Date' => <DateTime>,
                'Message' => '<string>',
                'Name' => 'Pending|Success|Failed',
            ],
            'SyncCompliance' => 'AUTO|MANUAL',
            'TargetLocations' => [
                [
                    'Accounts' => ['<string>', ...],
                    'ExecutionRoleName' => '<string>',
                    'Regions' => ['<string>', ...],
                    'TargetLocationMaxConcurrency' => '<string>',
                    'TargetLocationMaxErrors' => '<string>',
                ],
                // ...
            ],
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

Failed

Type: Array of FailedCreateAssociation structures

Information about the associations that failed.

Successful

Type: Array of AssociationDescription structures

Information about the associations that succeeded.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidDocumentVersion:
The document version is not valid or does not exist.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidParameters:
You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.
DuplicateInstanceId:
You cannot specify an instance ID in more than one association.
AssociationLimitExceeded:
You can have at most 2,000 active associations.
UnsupportedPlatformType:
The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.
InvalidOutputLocation:
The output location is not valid or does not exist.
InvalidTarget:
The target is not valid or does not exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
InvalidSchedule:
The schedule is invalid. Verify your cron or rate expression and try again.

CreateDocument

$result = $client->createDocument([/* ... */]);
$promise = $client->createDocumentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createDocument([
    'Attachments' => [
        [
            'Key' => 'SourceUrl|S3FileUrl|AttachmentReference',
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'Content' => '<string>', // REQUIRED
    'DocumentFormat' => 'YAML|JSON|TEXT',
    'DocumentType' => 'Command|Policy|Automation|Session|Package|ApplicationConfiguration|ApplicationConfigurationSchema|DeploymentStrategy|ChangeCalendar|Automation.ChangeTemplate',
    'Name' => '<string>', // REQUIRED
    'Requires' => [
        [
            'Name' => '<string>', // REQUIRED
            'Version' => '<string>',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TargetType' => '<string>',
    'VersionName' => '<string>',
]);

Parameter Details

Members

Attachments

Type: Array of AttachmentsSource structures

A list of key and value pairs that describe attachments to a version of a document.

Content

Required: Yes
Type: string

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the AWS Systems Manager User Guide.

DocumentFormat

Type: string

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

DocumentType

Type: string

The type of document to create.

Name

Required: Yes
Type: string

A name for the Systems Manager document.

You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:

aws-
amazon
amzn

Requires

Type: Array of DocumentRequires structures

A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see AWS AppConfig in the AWS Systems Manager User Guide.

Tags

Type: Array of Tag structures

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs:

Key=OS,Value=Windows
Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource action.

TargetType

Type: string

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide.

VersionName

Type: string

An optional field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Result Syntax

[
    'DocumentDescription' => [
        'ApprovedVersion' => '<string>',
        'AttachmentsInformation' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'Author' => '<string>',
        'CreatedDate' => <DateTime>,
        'DefaultVersion' => '<string>',
        'Description' => '<string>',
        'DocumentFormat' => 'YAML|JSON|TEXT',
        'DocumentType' => 'Command|Policy|Automation|Session|Package|ApplicationConfiguration|ApplicationConfigurationSchema|DeploymentStrategy|ChangeCalendar|Automation.ChangeTemplate',
        'DocumentVersion' => '<string>',
        'Hash' => '<string>',
        'HashType' => 'Sha256|Sha1',
        'LatestVersion' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'Parameters' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'Name' => '<string>',
                'Type' => 'String|StringList',
            ],
            // ...
        ],
        'PendingReviewVersion' => '<string>',
        'PlatformTypes' => ['<string>', ...],
        'Requires' => [
            [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'ReviewInformation' => [
            [
                'ReviewedTime' => <DateTime>,
                'Reviewer' => '<string>',
                'Status' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
            ],
            // ...
        ],
        'ReviewStatus' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
        'SchemaVersion' => '<string>',
        'Sha1' => '<string>',
        'Status' => 'Creating|Active|Updating|Deleting|Failed',
        'StatusInformation' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TargetType' => '<string>',
        'VersionName' => '<string>',
    ],
]

Result Details

Members

DocumentDescription

Type: DocumentDescription structure

Information about the Systems Manager document.

Errors

DocumentAlreadyExists:
The specified document already exists.
MaxDocumentSizeExceeded:
The size limit of a document is 64 KB.
InternalServerError:
An error occurred on the server side.
InvalidDocumentContent:
The content for the document is not valid.
DocumentLimitExceeded:
You can have at most 500 active Systems Manager documents.
InvalidDocumentSchemaVersion:
The version of the document schema is not supported.

CreateMaintenanceWindow

$result = $client->createMaintenanceWindow([/* ... */]);
$promise = $client->createMaintenanceWindowAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createMaintenanceWindow([
    'AllowUnassociatedTargets' => true || false, // REQUIRED
    'ClientToken' => '<string>',
    'Cutoff' => <integer>, // REQUIRED
    'Description' => '<string>',
    'Duration' => <integer>, // REQUIRED
    'EndDate' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Schedule' => '<string>', // REQUIRED
    'ScheduleOffset' => <integer>,
    'ScheduleTimezone' => '<string>',
    'StartDate' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

AllowUnassociatedTargets

Required: Yes
Type: boolean

Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

ClientToken

Type: string

User-provided idempotency token.

Cutoff

Required: Yes
Type: int

The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

Description

Type: string

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Duration

Required: Yes
Type: int

The duration of the maintenance window in hours.

EndDate

Type: string

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Name

Required: Yes
Type: string

The name of the maintenance window.

Schedule

Required: Yes
Type: string

The schedule of the maintenance window in the form of a cron or rate expression.

ScheduleOffset

Type: int

The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

cron(30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

ScheduleTimezone

Type: string

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

StartDate

Type: string

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Tags

Type: Array of Tag structures

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource action.

Result Syntax

[
    'WindowId' => '<string>',
]

Result Details

Members

WindowId

Type: string

The ID of the created maintenance window.

Errors

IdempotentParameterMismatch:
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
ResourceLimitExceededException:
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

CreateOpsItem

$result = $client->createOpsItem([/* ... */]);
$promise = $client->createOpsItemAsync([/* ... */]);

Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Parameter Syntax

$result = $client->createOpsItem([
    'ActualEndTime' => <integer || string || DateTime>,
    'ActualStartTime' => <integer || string || DateTime>,
    'Category' => '<string>',
    'Description' => '<string>', // REQUIRED
    'Notifications' => [
        [
            'Arn' => '<string>',
        ],
        // ...
    ],
    'OperationalData' => [
        '<OpsItemDataKey>' => [
            'Type' => 'SearchableString|String',
            'Value' => '<string>',
        ],
        // ...
    ],
    'OpsItemType' => '<string>',
    'PlannedEndTime' => <integer || string || DateTime>,
    'PlannedStartTime' => <integer || string || DateTime>,
    'Priority' => <integer>,
    'RelatedOpsItems' => [
        [
            'OpsItemId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Severity' => '<string>',
    'Source' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Title' => '<string>', // REQUIRED
]);

Parameter Details

Members

ActualEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

ActualStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

Category

Type: string

Specify a category to assign to an OpsItem.

Description

Required: Yes
Type: string

Information about the OpsItem.

Notifications

Type: Array of OpsItemNotification structures

The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

OperationalData

Type: Associative array of custom strings keys (OpsItemDataKey) to OpsItemDataValue structures

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.

OpsItemType

Type: string

The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.

PlannedEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

PlannedStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

Priority

Type: int

The importance of this OpsItem in relation to other OpsItems in the system.

RelatedOpsItems

Type: Array of RelatedOpsItem structures

One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

Severity

Type: string

Specify a severity to assign to an OpsItem.

Source

Required: Yes
Type: string

The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

The source name can't contain the following strings: aws, amazon, and amzn.

Tags

Type: Array of Tag structures

Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

Title

Required: Yes
Type: string

A short heading that describes the nature of the OpsItem and the impacted resource.

Result Syntax

[
    'OpsItemId' => '<string>',
]

Result Details

Members

OpsItemId

Type: string

The ID of the OpsItem.

Errors

InternalServerError:
An error occurred on the server side.
OpsItemAlreadyExistsException:
The OpsItem already exists.
OpsItemLimitExceededException:
The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.
OpsItemInvalidParameterException:
A specified parameter argument isn't valid. Verify the available arguments and try again.

CreateOpsMetadata

$result = $client->createOpsMetadata([/* ... */]);
$promise = $client->createOpsMetadataAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createOpsMetadata([
    'Metadata' => [
        '<MetadataKey>' => [
            'Value' => '<string>',
        ],
        // ...
    ],
    'ResourceId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Metadata

Type: Associative array of custom strings keys (MetadataKey) to MetadataValue structures

Metadata for a new Application Manager application.

ResourceId

Required: Yes
Type: string

A resource ID for a new Application Manager application.

Tags

Type: Array of Tag structures

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:

Key=Environment,Value=Production
Key=Region,Value=us-east-2

Result Syntax

[
    'OpsMetadataArn' => '<string>',
]

Result Details

Members

OpsMetadataArn

Type: string

The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.

Errors

OpsMetadataAlreadyExistsException:
An OpsMetadata object already exists for the selected resource.
OpsMetadataTooManyUpdatesException:
The system is processing too many concurrent updates. Wait a few moments and try again.
OpsMetadataInvalidArgumentException:
One of the arguments passed is invalid.
OpsMetadataLimitExceededException:
Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.
InternalServerError:
An error occurred on the server side.

CreatePatchBaseline

$result = $client->createPatchBaseline([/* ... */]);
$promise = $client->createPatchBaselineAsync([/* ... */]);

Creates a patch baseline.

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

Parameter Syntax

$result = $client->createPatchBaseline([
    'ApprovalRules' => [
        'PatchRules' => [ // REQUIRED
            [
                'ApproveAfterDays' => <integer>,
                'ApproveUntilDate' => '<string>',
                'ComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
                'EnableNonSecurity' => true || false,
                'PatchFilterGroup' => [ // REQUIRED
                    'PatchFilters' => [ // REQUIRED
                        [
                            'Key' => 'ARCH|ADVISORY_ID|BUGZILLA_ID|PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|CVE_ID|EPOCH|MSRC_SEVERITY|NAME|PATCH_ID|SECTION|PRIORITY|REPOSITORY|RELEASE|SEVERITY|SECURITY|VERSION', // REQUIRED
                            'Values' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
    ],
    'ApprovedPatches' => ['<string>', ...],
    'ApprovedPatchesComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
    'ApprovedPatchesEnableNonSecurity' => true || false,
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'GlobalFilters' => [
        'PatchFilters' => [ // REQUIRED
            [
                'Key' => 'ARCH|ADVISORY_ID|BUGZILLA_ID|PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|CVE_ID|EPOCH|MSRC_SEVERITY|NAME|PATCH_ID|SECTION|PRIORITY|REPOSITORY|RELEASE|SEVERITY|SECURITY|VERSION', // REQUIRED
                'Values' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS',
    'RejectedPatches' => ['<string>', ...],
    'RejectedPatchesAction' => 'ALLOW_AS_DEPENDENCY|BLOCK',
    'Sources' => [
        [
            'Configuration' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
            'Products' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ApprovalRules

Type: PatchRuleGroup structure

A set of rules used to include patches in the baseline.

ApprovedPatches

Type: Array of strings

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.

ApprovedPatchesComplianceLevel

Type: string

Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED.

ApprovedPatchesEnableNonSecurity

Type: boolean

Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

ClientToken

Type: string

User-provided idempotency token.

Description

Type: string

A description of the patch baseline.

GlobalFilters

Type: PatchFilterGroup structure

A set of global filters used to include patches in the baseline.

Name

Required: Yes
Type: string

The name of the patch baseline.

OperatingSystem

Type: string

Defines the operating system the patch baseline applies to. The Default value is WINDOWS.

RejectedPatches

Type: Array of strings

A list of explicitly rejected patches for the baseline.

RejectedPatchesAction

Type: string

The action for Patch Manager to take on patches included in the RejectedPackages list.

ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.
BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.

Sources

Type: Array of PatchSource structures

Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

Tags

Type: Array of Tag structures

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key name/value pairs:

Key=PatchSeverity,Value=Critical
Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource action.

Result Syntax

[
    'BaselineId' => '<string>',
]

Result Details

Members

BaselineId

Type: string

The ID of the created patch baseline.

Errors

IdempotentParameterMismatch:
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
ResourceLimitExceededException:
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

CreateResourceDataSync

$result = $client->createResourceDataSync([/* ... */]);
$promise = $client->createResourceDataSyncAsync([/* ... */]);

A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.

You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.

You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization by using AWS Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager User Guide.

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.

By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

Parameter Syntax

$result = $client->createResourceDataSync([
    'S3Destination' => [
        'AWSKMSKeyARN' => '<string>',
        'BucketName' => '<string>', // REQUIRED
        'DestinationDataSharing' => [
            'DestinationDataSharingType' => '<string>',
        ],
        'Prefix' => '<string>',
        'Region' => '<string>', // REQUIRED
        'SyncFormat' => 'JsonSerDe', // REQUIRED
    ],
    'SyncName' => '<string>', // REQUIRED
    'SyncSource' => [
        'AwsOrganizationsSource' => [
            'OrganizationSourceType' => '<string>', // REQUIRED
            'OrganizationalUnits' => [
                [
                    'OrganizationalUnitId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnableAllOpsDataSources' => true || false,
        'IncludeFutureRegions' => true || false,
        'SourceRegions' => ['<string>', ...], // REQUIRED
        'SourceType' => '<string>', // REQUIRED
    ],
    'SyncType' => '<string>',
]);

Parameter Details

Members

S3Destination

Type: ResourceDataSyncS3Destination structure

Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.

SyncName

Required: Yes
Type: string

A name for the configuration.

SyncSource

Type: ResourceDataSyncSource structure

Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.

SyncType

Type: string

Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple AWS accounts and Regions, as listed in AWS Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
An error occurred on the server side.
ResourceDataSyncCountExceededException:
You have exceeded the allowed maximum sync configurations.
ResourceDataSyncAlreadyExistsException:
A sync configuration with the same name already exists.
ResourceDataSyncInvalidConfigurationException:
The specified sync configuration is invalid.

DeleteActivation

$result = $client->deleteActivation([/* ... */]);
$promise = $client->deleteActivationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteActivation([
    'ActivationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ActivationId

Required: Yes
Type: string

The ID of the activation that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidActivationId:
The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
InvalidActivation:
The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.
InternalServerError:
An error occurred on the server side.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.

DeleteAssociation

$result = $client->deleteAssociation([/* ... */]);
$promise = $client->deleteAssociationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteAssociation([
    'AssociationId' => '<string>',
    'InstanceId' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Members

AssociationId

Type: string

The association ID that you want to delete.

InstanceId

Type: string

The ID of the instance.

Name

Type: string

The name of the Systems Manager document.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AssociationDoesNotExist:
The specified association does not exist.
InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.

DeleteDocument

$result = $client->deleteDocument([/* ... */]);
$promise = $client->deleteDocumentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteDocument([
    'DocumentVersion' => '<string>',
    'Force' => true || false,
    'Name' => '<string>', // REQUIRED
    'VersionName' => '<string>',
]);

Parameter Details

Members

DocumentVersion

Type: string

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Force

Type: boolean

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Name

Required: Yes
Type: string

The name of the document.

VersionName

Type: string

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidDocumentOperation:
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
AssociatedInstances:
You must disassociate a document from all instances before you can delete it.

DeleteInventory

$result = $client->deleteInventory([/* ... */]);
$promise = $client->deleteInventoryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteInventory([
    'ClientToken' => '<string>',
    'DryRun' => true || false,
    'SchemaDeleteOption' => 'DisableSchema|DeleteSchema',
    'TypeName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientToken

Type: string

User-provided idempotency token.

DryRun

Type: boolean

Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

SchemaDeleteOption

Type: string

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

TypeName

Required: Yes
Type: string

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Result Syntax

[
    'DeletionId' => '<string>',
    'DeletionSummary' => [
        'RemainingCount' => <integer>,
        'SummaryItems' => [
            [
                'Count' => <integer>,
                'RemainingCount' => <integer>,
                'Version' => '<string>',
            ],
            // ...
        ],
        'TotalCount' => <integer>,
    ],
    'TypeName' => '<string>',
]

Result Details

Members

DeletionId

Type: string

Every DeleteInventory action is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other actions.

DeletionSummary

Type: InventoryDeletionSummary structure

A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the AWS Systems Manager User Guide.

TypeName

Type: string

The name of the inventory data type specified in the request.

Errors

InternalServerError:
An error occurred on the server side.
InvalidTypeNameException:
The parameter type name is not valid.
InvalidOptionException:
The delete inventory option specified is not valid. Verify the option and try again.
InvalidDeleteInventoryParametersException:
One or more of the parameters specified for the delete operation is not valid. Verify all parameters and try again.
InvalidInventoryRequestException:
The request is not valid.

DeleteMaintenanceWindow

$result = $client->deleteMaintenanceWindow([/* ... */]);
$promise = $client->deleteMaintenanceWindowAsync([/* ... */]);

Deletes a maintenance window.

Parameter Syntax

$result = $client->deleteMaintenanceWindow([
    'WindowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

WindowId

Required: Yes
Type: string

The ID of the maintenance window to delete.

Result Syntax

[
    'WindowId' => '<string>',
]

Result Details

Members

WindowId

Type: string

The ID of the deleted maintenance window.

Errors

InternalServerError:
An error occurred on the server side.

DeleteOpsMetadata

$result = $client->deleteOpsMetadata([/* ... */]);
$promise = $client->deleteOpsMetadataAsync([/* ... */]);

Delete OpsMetadata related to an application.

Parameter Syntax

$result = $client->deleteOpsMetadata([
    'OpsMetadataArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

OpsMetadataArn

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

OpsMetadataNotFoundException:
The OpsMetadata object does not exist.
OpsMetadataInvalidArgumentException:
One of the arguments passed is invalid.
InternalServerError:
An error occurred on the server side.

DeleteParameter

$result = $client->deleteParameter([/* ... */]);
$promise = $client->deleteParameterAsync([/* ... */]);

Delete a parameter from the system.

Parameter Syntax

$result = $client->deleteParameter([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the parameter to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
An error occurred on the server side.
ParameterNotFound:
The parameter could not be found. Verify the name and try again.

DeleteParameters

$result = $client->deleteParameters([/* ... */]);
$promise = $client->deleteParametersAsync([/* ... */]);

Delete a list of parameters.

Parameter Syntax

$result = $client->deleteParameters([
    'Names' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

Names

Required: Yes
Type: Array of strings

The names of the parameters to delete.

Result Syntax

[
    'DeletedParameters' => ['<string>', ...],
    'InvalidParameters' => ['<string>', ...],
]

Result Details

Members

DeletedParameters

Type: Array of strings

The names of the deleted parameters.

InvalidParameters

Type: Array of strings

The names of parameters that weren't deleted because the parameters are not valid.

Errors

InternalServerError:
An error occurred on the server side.

DeletePatchBaseline

$result = $client->deletePatchBaseline([/* ... */]);
$promise = $client->deletePatchBaselineAsync([/* ... */]);

Deletes a patch baseline.

Parameter Syntax

$result = $client->deletePatchBaseline([
    'BaselineId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BaselineId

Required: Yes
Type: string

The ID of the patch baseline to delete.

Result Syntax

[
    'BaselineId' => '<string>',
]

Result Details

Members

BaselineId

Type: string

The ID of the deleted patch baseline.

Errors

ResourceInUseException:
Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.
InternalServerError:
An error occurred on the server side.

DeleteResourceDataSync

$result = $client->deleteResourceDataSync([/* ... */]);
$promise = $client->deleteResourceDataSyncAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteResourceDataSync([
    'SyncName' => '<string>', // REQUIRED
    'SyncType' => '<string>',
]);

Parameter Details

Members

SyncName

Required: Yes
Type: string

The name of the configuration to delete.

SyncType

Type: string

Specify the type of resource data sync to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
An error occurred on the server side.
ResourceDataSyncNotFoundException:
The specified sync name was not found.
ResourceDataSyncInvalidConfigurationException:
The specified sync configuration is invalid.

DeregisterManagedInstance

$result = $client->deregisterManagedInstance([/* ... */]);
$promise = $client->deregisterManagedInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deregisterManagedInstance([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InternalServerError:
An error occurred on the server side.

DeregisterPatchBaselineForPatchGroup

$result = $client->deregisterPatchBaselineForPatchGroup([/* ... */]);
$promise = $client->deregisterPatchBaselineForPatchGroupAsync([/* ... */]);

Removes a patch group from a patch baseline.

Parameter Syntax

$result = $client->deregisterPatchBaselineForPatchGroup([
    'BaselineId' => '<string>', // REQUIRED
    'PatchGroup' => '<string>', // REQUIRED
]);

Parameter Details

Members

BaselineId

Required: Yes
Type: string

The ID of the patch baseline to deregister the patch group from.

PatchGroup

Required: Yes
Type: string

The name of the patch group that should be deregistered from the patch baseline.

Result Syntax

[
    'BaselineId' => '<string>',
    'PatchGroup' => '<string>',
]

Result Details

Members

BaselineId

Type: string

The ID of the patch baseline the patch group was deregistered from.

PatchGroup

Type: string

The name of the patch group deregistered from the patch baseline.

Errors

InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.
InternalServerError:
An error occurred on the server side.

DeregisterTargetFromMaintenanceWindow

$result = $client->deregisterTargetFromMaintenanceWindow([/* ... */]);
$promise = $client->deregisterTargetFromMaintenanceWindowAsync([/* ... */]);

Removes a target from a maintenance window.

Parameter Syntax

$result = $client->deregisterTargetFromMaintenanceWindow([
    'Safe' => true || false,
    'WindowId' => '<string>', // REQUIRED
    'WindowTargetId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Safe

Type: boolean

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

WindowId

Required: Yes
Type: string

The ID of the maintenance window the target should be removed from.

WindowTargetId

Required: Yes
Type: string

The ID of the target definition to remove.

Result Syntax

[
    'WindowId' => '<string>',
    'WindowTargetId' => '<string>',
]

Result Details

Members

WindowId

Type: string

The ID of the maintenance window the target was removed from.

WindowTargetId

Type: string

The ID of the removed target definition.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.
TargetInUseException:
You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

DeregisterTaskFromMaintenanceWindow

$result = $client->deregisterTaskFromMaintenanceWindow([/* ... */]);
$promise = $client->deregisterTaskFromMaintenanceWindowAsync([/* ... */]);

Removes a task from a maintenance window.

Parameter Syntax

$result = $client->deregisterTaskFromMaintenanceWindow([
    'WindowId' => '<string>', // REQUIRED
    'WindowTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members

WindowId

Required: Yes
Type: string

The ID of the maintenance window the task should be removed from.

WindowTaskId

Required: Yes
Type: string

The ID of the task to remove from the maintenance window.

Result Syntax

[
    'WindowId' => '<string>',
    'WindowTaskId' => '<string>',
]

Result Details

Members

WindowId

Type: string

The ID of the maintenance window the task was removed from.

WindowTaskId

Type: string

The ID of the task removed from the maintenance window.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

DescribeActivations

$result = $client->describeActivations([/* ... */]);
$promise = $client->describeActivationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeActivations([
    'Filters' => [
        [
            'FilterKey' => 'ActivationIds|DefaultInstanceName|IamRole',
            'FilterValues' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of DescribeActivationsFilter structures

A filter to view information about your activations.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'ActivationList' => [
        [
            'ActivationId' => '<string>',
            'CreatedDate' => <DateTime>,
            'DefaultInstanceName' => '<string>',
            'Description' => '<string>',
            'ExpirationDate' => <DateTime>,
            'Expired' => true || false,
            'IamRole' => '<string>',
            'RegistrationLimit' => <integer>,
            'RegistrationsCount' => <integer>,
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ActivationList

Type: Array of Activation structures

A list of activations for your AWS account.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InvalidFilter:
The filter name is not valid. Verify the you entered the correct name and try again.
InvalidNextToken:
The specified token is not valid.
InternalServerError:
An error occurred on the server side.

DescribeAssociation

$result = $client->describeAssociation([/* ... */]);
$promise = $client->describeAssociationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeAssociation([
    'AssociationId' => '<string>',
    'AssociationVersion' => '<string>',
    'InstanceId' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Members

AssociationId

Type: string

The association ID for which you want information.

AssociationVersion

Type: string

Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

InstanceId

Type: string

The instance ID.

Name

Type: string

The name of the Systems Manager document.

Result Syntax

[
    'AssociationDescription' => [
        'ApplyOnlyAtCronInterval' => true || false,
        'AssociationId' => '<string>',
        'AssociationName' => '<string>',
        'AssociationVersion' => '<string>',
        'AutomationTargetParameterName' => '<string>',
        'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
        'Date' => <DateTime>,
        'DocumentVersion' => '<string>',
        'InstanceId' => '<string>',
        'LastExecutionDate' => <DateTime>,
        'LastSuccessfulExecutionDate' => <DateTime>,
        'LastUpdateAssociationDate' => <DateTime>,
        'MaxConcurrency' => '<string>',
        'MaxErrors' => '<string>',
        'Name' => '<string>',
        'OutputLocation' => [
            'S3Location' => [
                'OutputS3BucketName' => '<string>',
                'OutputS3KeyPrefix' => '<string>',
                'OutputS3Region' => '<string>',
            ],
        ],
        'Overview' => [
            'AssociationStatusAggregatedCount' => [<integer>, ...],
            'DetailedStatus' => '<string>',
            'Status' => '<string>',
        ],
        'Parameters' => [
            '<ParameterName>' => ['<string>', ...],
            // ...
        ],
        'ScheduleExpression' => '<string>',
        'Status' => [
            'AdditionalInfo' => '<string>',
            'Date' => <DateTime>,
            'Message' => '<string>',
            'Name' => 'Pending|Success|Failed',
        ],
        'SyncCompliance' => 'AUTO|MANUAL',
        'TargetLocations' => [
            [
                'Accounts' => ['<string>', ...],
                'ExecutionRoleName' => '<string>',
                'Regions' => ['<string>', ...],
                'TargetLocationMaxConcurrency' => '<string>',
                'TargetLocationMaxErrors' => '<string>',
            ],
            // ...
        ],
        'Targets' => [
            [
                'Key' => '<string>',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Members

AssociationDescription

Type: AssociationDescription structure

Information about the association.

Errors

AssociationDoesNotExist:
The specified association does not exist.
InvalidAssociationVersion:
The version you specified is not valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.
InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

DescribeAssociationExecutionTargets

$result = $client->describeAssociationExecutionTargets([/* ... */]);
$promise = $client->describeAssociationExecutionTargetsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeAssociationExecutionTargets([
    'AssociationId' => '<string>', // REQUIRED
    'ExecutionId' => '<string>', // REQUIRED
    'Filters' => [
        [
            'Key' => 'Status|ResourceId|ResourceType', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AssociationId

Required: Yes
Type: string

The association ID that includes the execution for which you want to view details.

ExecutionId

Required: Yes
Type: string

The execution ID for which you want to view details.

Filters

Type: Array of AssociationExecutionTargetsFilter structures

Filters for the request. You can specify the following filters and values.

Status (EQUAL)

ResourceId (EQUAL)

ResourceType (EQUAL)

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'AssociationExecutionTargets' => [
        [
            'AssociationId' => '<string>',
            'AssociationVersion' => '<string>',
            'DetailedStatus' => '<string>',
            'ExecutionId' => '<string>',
            'LastExecutionDate' => <DateTime>,
            'OutputSource' => [
                'OutputSourceId' => '<string>',
                'OutputSourceType' => '<string>',
            ],
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
            'Status' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AssociationExecutionTargets

Type: Array of AssociationExecutionTarget structures

Information about the execution.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerError:
An error occurred on the server side.
AssociationDoesNotExist:
The specified association does not exist.
InvalidNextToken:
The specified token is not valid.
AssociationExecutionDoesNotExist:
The specified execution ID does not exist. Verify the ID number and try again.

DescribeAssociationExecutions

$result = $client->describeAssociationExecutions([/* ... */]);
$promise = $client->describeAssociationExecutionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeAssociationExecutions([
    'AssociationId' => '<string>', // REQUIRED
    'Filters' => [
        [
            'Key' => 'ExecutionId|Status|CreatedTime', // REQUIRED
            'Type' => 'EQUAL|LESS_THAN|GREATER_THAN', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AssociationId

Required: Yes
Type: string

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

Filters

Type: Array of AssociationExecutionFilter structures

Filters for the request. You can specify the following filters and values.

ExecutionId (EQUAL)

Status (EQUAL)

CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'AssociationExecutions' => [
        [
            'AssociationId' => '<string>',
            'AssociationVersion' => '<string>',
            'CreatedTime' => <DateTime>,
            'DetailedStatus' => '<string>',
            'ExecutionId' => '<string>',
            'LastExecutionDate' => <DateTime>,
            'ResourceCountByStatus' => '<string>',
            'Status' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AssociationExecutions

Type: Array of AssociationExecution structures

A list of the executions for the specified association ID.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerError:
An error occurred on the server side.
AssociationDoesNotExist:
The specified association does not exist.
InvalidNextToken:
The specified token is not valid.

DescribeAutomationExecutions

$result = $client->describeAutomationExecutions([/* ... */]);
$promise = $client->describeAutomationExecutionsAsync([/* ... */]);

Provides details about all active and terminated Automation executions.

Parameter Syntax

$result = $client->describeAutomationExecutions([
    'Filters' => [
        [
            'Key' => 'DocumentNamePrefix|ExecutionStatus|ExecutionId|ParentExecutionId|CurrentAction|StartTimeBefore|StartTimeAfter|AutomationType|TagKey|TargetResourceGroup|AutomationSubtype|OpsItemId', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of AutomationExecutionFilter structures

Filters used to limit the scope of executions that are requested.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'AutomationExecutionMetadataList' => [
        [
            'AssociationId' => '<string>',
            'AutomationExecutionId' => '<string>',
            'AutomationExecutionStatus' => 'Pending|InProgress|Waiting|Success|TimedOut|Cancelling|Cancelled|Failed|PendingApproval|Approved|Rejected|Scheduled|RunbookInProgress|PendingChangeCalendarOverride|ChangeCalendarOverrideApproved|ChangeCalendarOverrideRejected|CompletedWithSuccess|CompletedWithFailure',
            'AutomationSubtype' => 'ChangeRequest',
            'AutomationType' => 'CrossAccount|Local',
            'ChangeRequestName' => '<string>',
            'CurrentAction' => '<string>',
            'CurrentStepName' => '<string>',
            'DocumentName' => '<string>',
            'DocumentVersion' => '<string>',
            'ExecutedBy' => '<string>',
            'ExecutionEndTime' => <DateTime>,
            'ExecutionStartTime' => <DateTime>,
            'FailureMessage' => '<string>',
            'LogFile' => '<string>',
            'MaxConcurrency' => '<string>',
            'MaxErrors' => '<string>',
            'Mode' => 'Auto|Interactive',
            'OpsItemId' => '<string>',
            'Outputs' => [
                '<AutomationParameterKey>' => ['<string>', ...],
                // ...
            ],
            'ParentAutomationExecutionId' => '<string>',
            'ResolvedTargets' => [
                'ParameterValues' => ['<string>', ...],
                'Truncated' => true || false,
            ],
            'Runbooks' => [
                [
                    'DocumentName' => '<string>',
                    'DocumentVersion' => '<string>',
                    'MaxConcurrency' => '<string>',
                    'MaxErrors' => '<string>',
                    'Parameters' => [
                        '<AutomationParameterKey>' => ['<string>', ...],
                        // ...
                    ],
                    'TargetLocations' => [
                        [
                            'Accounts' => ['<string>', ...],
                            'ExecutionRoleName' => '<string>',
                            'Regions' => ['<string>', ...],
                            'TargetLocationMaxConcurrency' => '<string>',
                            'TargetLocationMaxErrors' => '<string>',
                        ],
                        // ...
                    ],
                    'TargetParameterName' => '<string>',
                    'Targets' => [
                        [
                            'Key' => '<string>',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'ScheduledTime' => <DateTime>,
            'Target' => '<string>',
            'TargetMaps' => [
                [
                    '<TargetMapKey>' => ['<string>', ...],
                    // ...
                ],
                // ...
            ],
            'TargetParameterName' => '<string>',
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AutomationExecutionMetadataList

Type: Array of AutomationExecutionMetadata structures

The list of details about each automation execution which has occurred which matches the filter specification, if any.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InvalidFilterKey:
The specified key is not valid.
InvalidFilterValue:
The filter value is not valid. Verify the value and try again.
InvalidNextToken:
The specified token is not valid.
InternalServerError:
An error occurred on the server side.

DescribeAutomationStepExecutions

$result = $client->describeAutomationStepExecutions([/* ... */]);
$promise = $client->describeAutomationStepExecutionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeAutomationStepExecutions([
    'AutomationExecutionId' => '<string>', // REQUIRED
    'Filters' => [
        [
            'Key' => 'StartTimeBefore|StartTimeAfter|StepExecutionStatus|StepExecutionId|StepName|Action', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ReverseOrder' => true || false,
]);

Parameter Details

Members

AutomationExecutionId

Required: Yes
Type: string

The Automation execution ID for which you want step execution descriptions.

Filters

Type: Array of StepExecutionFilter structures

One or more filters to limit the number of step executions returned by the request.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

ReverseOrder

Type: boolean

A boolean that indicates whether to list step executions in reverse order by start time. The default value is 'false'.

Result Syntax

[
    'NextToken' => '<string>',
    'StepExecutions' => [
        [
            'Action' => '<string>',
            'ExecutionEndTime' => <DateTime>,
            'ExecutionStartTime' => <DateTime>,
            'FailureDetails' => [
                'Details' => [
                    '<AutomationParameterKey>' => ['<string>', ...],
                    // ...
                ],
                'FailureStage' => '<string>',
                'FailureType' => '<string>',
            ],
            'FailureMessage' => '<string>',
            'Inputs' => ['<string>', ...],
            'IsCritical' => true || false,
            'IsEnd' => true || false,
            'MaxAttempts' => <integer>,
            'NextStep' => '<string>',
            'OnFailure' => '<string>',
            'Outputs' => [
                '<AutomationParameterKey>' => ['<string>', ...],
                // ...
            ],
            'OverriddenParameters' => [
                '<AutomationParameterKey>' => ['<string>', ...],
                // ...
            ],
            'Response' => '<string>',
            'ResponseCode' => '<string>',
            'StepExecutionId' => '<string>',
            'StepName' => '<string>',
            'StepStatus' => 'Pending|InProgress|Waiting|Success|TimedOut|Cancelling|Cancelled|Failed|PendingApproval|Approved|Rejected|Scheduled|RunbookInProgress|PendingChangeCalendarOverride|ChangeCalendarOverrideApproved|ChangeCalendarOverrideRejected|CompletedWithSuccess|CompletedWithFailure',
            'TargetLocation' => [
                'Accounts' => ['<string>', ...],
                'ExecutionRoleName' => '<string>',
                'Regions' => ['<string>', ...],
                'TargetLocationMaxConcurrency' => '<string>',
                'TargetLocationMaxErrors' => '<string>',
            ],
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'TimeoutSeconds' => <integer>,
            'ValidNextSteps' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

StepExecutions

Type: Array of StepExecution structures

A list of details about the current state of all steps that make up an execution.

Errors

AutomationExecutionNotFoundException:
There is no automation execution information for the requested automation execution ID.
InvalidNextToken:
The specified token is not valid.
InvalidFilterKey:
The specified key is not valid.
InvalidFilterValue:
The filter value is not valid. Verify the value and try again.
InternalServerError:
An error occurred on the server side.

DescribeAvailablePatches

$result = $client->describeAvailablePatches([/* ... */]);
$promise = $client->describeAvailablePatchesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeAvailablePatches([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of PatchOrchestratorFilter structures

Filters used to scope down the returned patches.

MaxResults

Type: int

The maximum number of patches to return (per page).

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'NextToken' => '<string>',
    'Patches' => [
        [
            'AdvisoryIds' => ['<string>', ...],
            'Arch' => '<string>',
            'BugzillaIds' => ['<string>', ...],
            'CVEIds' => ['<string>', ...],
            'Classification' => '<string>',
            'ContentUrl' => '<string>',
            'Description' => '<string>',
            'Epoch' => <integer>,
            'Id' => '<string>',
            'KbNumber' => '<string>',
            'Language' => '<string>',
            'MsrcNumber' => '<string>',
            'MsrcSeverity' => '<string>',
            'Name' => '<string>',
            'Product' => '<string>',
            'ProductFamily' => '<string>',
            'Release' => '<string>',
            'ReleaseDate' => <DateTime>,
            'Repository' => '<string>',
            'Severity' => '<string>',
            'Title' => '<string>',
            'Vendor' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Patches

Type: Array of Patch structures

An array of patches. Each entry in the array is a patch structure.

Errors

InternalServerError:
An error occurred on the server side.

DescribeDocument

$result = $client->describeDocument([/* ... */]);
$promise = $client->describeDocumentAsync([/* ... */]);

Describes the specified Systems Manager document.

Parameter Syntax

$result = $client->describeDocument([
    'DocumentVersion' => '<string>',
    'Name' => '<string>', // REQUIRED
    'VersionName' => '<string>',
]);

Parameter Details

Members

DocumentVersion

Type: string

The document version for which you want information. Can be a specific version or the default version.

Name

Required: Yes
Type: string

The name of the Systems Manager document.

VersionName

Type: string

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Result Syntax

[
    'Document' => [
        'ApprovedVersion' => '<string>',
        'AttachmentsInformation' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'Author' => '<string>',
        'CreatedDate' => <DateTime>,
        'DefaultVersion' => '<string>',
        'Description' => '<string>',
        'DocumentFormat' => 'YAML|JSON|TEXT',
        'DocumentType' => 'Command|Policy|Automation|Session|Package|ApplicationConfiguration|ApplicationConfigurationSchema|DeploymentStrategy|ChangeCalendar|Automation.ChangeTemplate',
        'DocumentVersion' => '<string>',
        'Hash' => '<string>',
        'HashType' => 'Sha256|Sha1',
        'LatestVersion' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'Parameters' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'Name' => '<string>',
                'Type' => 'String|StringList',
            ],
            // ...
        ],
        'PendingReviewVersion' => '<string>',
        'PlatformTypes' => ['<string>', ...],
        'Requires' => [
            [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'ReviewInformation' => [
            [
                'ReviewedTime' => <DateTime>,
                'Reviewer' => '<string>',
                'Status' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
            ],
            // ...
        ],
        'ReviewStatus' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
        'SchemaVersion' => '<string>',
        'Sha1' => '<string>',
        'Status' => 'Creating|Active|Updating|Deleting|Failed',
        'StatusInformation' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TargetType' => '<string>',
        'VersionName' => '<string>',
    ],
]

Result Details

Members

Document

Type: DocumentDescription structure

Information about the Systems Manager document.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidDocumentVersion:
The document version is not valid or does not exist.

DescribeDocumentPermission

$result = $client->describeDocumentPermission([/* ... */]);
$promise = $client->describeDocumentPermissionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDocumentPermission([
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'PermissionType' => 'Share', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Name

Required: Yes
Type: string

The name of the document for which you are the owner.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

PermissionType

Required: Yes
Type: string

The permission type for the document. The permission type can be Share.

Result Syntax

[
    'AccountIds' => ['<string>', ...],
    'AccountSharingInfoList' => [
        [
            'AccountId' => '<string>',
            'SharedDocumentVersion' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AccountIds

Type: Array of strings

The account IDs that have permission to use this document. The ID can be either an AWS account or All.

AccountSharingInfoList

Type: Array of AccountSharingInfo structures

A list of AWS accounts where the current document is shared and the version shared with each account.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidNextToken:
The specified token is not valid.
InvalidPermissionType:
The permission type is not supported. Share is the only supported permission type.
InvalidDocumentOperation:
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

DescribeEffectiveInstanceAssociations

$result = $client->describeEffectiveInstanceAssociations([/* ... */]);
$promise = $client->describeEffectiveInstanceAssociationsAsync([/* ... */]);

All associations for the instance(s).

Parameter Syntax

$result = $client->describeEffectiveInstanceAssociations([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

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

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'Associations' => [
        [
            'AssociationId' => '<string>',
            'AssociationVersion' => '<string>',
            'Content' => '<string>',
            'InstanceId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Associations

Type: Array of InstanceAssociation structures

The associations for the requested instance.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextToken:
The specified token is not valid.

DescribeEffectivePatchesForPatchBaseline

$result = $client->describeEffectivePatchesForPatchBaseline([/* ... */]);
$promise = $client->describeEffectivePatchesForPatchBaselineAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeEffectivePatchesForPatchBaseline([
    'BaselineId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

BaselineId

Required: Yes
Type: string

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

MaxResults

Type: int

The maximum number of patches to return (per page).

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'EffectivePatches' => [
        [
            'Patch' => [
                'AdvisoryIds' => ['<string>', ...],
                'Arch' => '<string>',
                'BugzillaIds' => ['<string>', ...],
                'CVEIds' => ['<string>', ...],
                'Classification' => '<string>',
                'ContentUrl' => '<string>',
                'Description' => '<string>',
                'Epoch' => <integer>,
                'Id' => '<string>',
                'KbNumber' => '<string>',
                'Language' => '<string>',
                'MsrcNumber' => '<string>',
                'MsrcSeverity' => '<string>',
                'Name' => '<string>',
                'Product' => '<string>',
                'ProductFamily' => '<string>',
                'Release' => '<string>',
                'ReleaseDate' => <DateTime>,
                'Repository' => '<string>',
                'Severity' => '<string>',
                'Title' => '<string>',
                'Vendor' => '<string>',
                'Version' => '<string>',
            ],
            'PatchStatus' => [
                'ApprovalDate' => <DateTime>,
                'ComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
                'DeploymentStatus' => 'APPROVED|PENDING_APPROVAL|EXPLICIT_APPROVED|EXPLICIT_REJECTED',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

EffectivePatches

Type: Array of EffectivePatch structures

An array of patches and patch status.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.
DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
UnsupportedOperatingSystem:
The operating systems you specified is not supported, or the operation is not supported for the operating system.
InternalServerError:
An error occurred on the server side.

DescribeInstanceAssociationsStatus

$result = $client->describeInstanceAssociationsStatus([/* ... */]);
$promise = $client->describeInstanceAssociationsStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeInstanceAssociationsStatus([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The instance IDs for which you want association status information.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'InstanceAssociationStatusInfos' => [
        [
            'AssociationId' => '<string>',
            'AssociationName' => '<string>',
            'AssociationVersion' => '<string>',
            'DetailedStatus' => '<string>',
            'DocumentVersion' => '<string>',
            'ErrorCode' => '<string>',
            'ExecutionDate' => <DateTime>,
            'ExecutionSummary' => '<string>',
            'InstanceId' => '<string>',
            'Name' => '<string>',
            'OutputUrl' => [
                'S3OutputUrl' => [
                    'OutputUrl' => '<string>',
                ],
            ],
            'Status' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

InstanceAssociationStatusInfos

Type: Array of InstanceAssociationStatusInfo structures

Status information about the association.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextToken:
The specified token is not valid.

DescribeInstanceInformation

$result = $client->describeInstanceInformation([/* ... */]);
$promise = $client->describeInstanceInformationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeInstanceInformation([
    'Filters' => [
        [
            'Key' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'InstanceInformationFilterList' => [
        [
            'key' => 'InstanceIds|AgentVersion|PingStatus|PlatformTypes|ActivationIds|IamRole|ResourceType|AssociationStatus', // REQUIRED
            'valueSet' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of InstanceInformationStringFilter structures

One or more filters. Use a filter to return a more specific list of instances. You can filter based on tags applied to EC2 instances. Use this Filters data type instead of InstanceInformationFilterList, which is deprecated.

InstanceInformationFilterList

Type: Array of InstanceInformationFilter structures

This is a legacy method. We recommend that you don't use this method. Instead, use the Filters data type. Filters enables you to return instance information by filtering based on tags applied to managed instances.

Attempting to use InstanceInformationFilterList and Filters leads to an exception error.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'InstanceInformationList' => [
        [
            'ActivationId' => '<string>',
            'AgentVersion' => '<string>',
            'AssociationOverview' => [
                'DetailedStatus' => '<string>',
                'InstanceAssociationStatusAggregatedCount' => [<integer>, ...],
            ],
            'AssociationStatus' => '<string>',
            'ComputerName' => '<string>',
            'IPAddress' => '<string>',
            'IamRole' => '<string>',
            'InstanceId' => '<string>',
            'IsLatestVersion' => true || false,
            'LastAssociationExecutionDate' => <DateTime>,
            'LastPingDateTime' => <DateTime>,
            'LastSuccessfulAssociationExecutionDate' => <DateTime>,
            'Name' => '<string>',
            'PingStatus' => 'Online|ConnectionLost|Inactive',
            'PlatformName' => '<string>',
            'PlatformType' => 'Windows|Linux',
            'PlatformVersion' => '<string>',
            'RegistrationDate' => <DateTime>,
            'ResourceType' => 'ManagedInstance|Document|EC2Instance',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

InstanceInformationList

Type: Array of InstanceInformation structures

The instance information list.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextToken:
The specified token is not valid.
InvalidInstanceInformationFilterValue:
The specified filter value is not valid.
InvalidFilterKey:
The specified key is not valid.

DescribeInstancePatchStates

$result = $client->describeInstancePatchStates([/* ... */]);
$promise = $client->describeInstancePatchStatesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeInstancePatchStates([
    'InstanceIds' => ['<string>', ...], // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceIds

Required: Yes
Type: Array of strings

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

MaxResults

Type: int

The maximum number of instances to return (per page).

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'InstancePatchStates' => [
        [
            'BaselineId' => '<string>',
            'CriticalNonCompliantCount' => <integer>,
            'FailedCount' => <integer>,
            'InstallOverrideList' => '<string>',
            'InstalledCount' => <integer>,
            'InstalledOtherCount' => <integer>,
            'InstalledPendingRebootCount' => <integer>,
            'InstalledRejectedCount' => <integer>,
            'InstanceId' => '<string>',
            'LastNoRebootInstallOperationTime' => <DateTime>,
            'MissingCount' => <integer>,
            'NotApplicableCount' => <integer>,
            'Operation' => 'Scan|Install',
            'OperationEndTime' => <DateTime>,
            'OperationStartTime' => <DateTime>,
            'OtherNonCompliantCount' => <integer>,
            'OwnerInformation' => '<string>',
            'PatchGroup' => '<string>',
            'RebootOption' => 'RebootIfNeeded|NoReboot',
            'SecurityNonCompliantCount' => <integer>,
            'SnapshotId' => '<string>',
            'UnreportedNotApplicableCount' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

InstancePatchStates

Type: Array of InstancePatchState structures

The high-level patch state for the requested instances.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidNextToken:
The specified token is not valid.

DescribeInstancePatchStatesForPatchGroup

$result = $client->describeInstancePatchStatesForPatchGroup([/* ... */]);
$promise = $client->describeInstancePatchStatesForPatchGroupAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeInstancePatchStatesForPatchGroup([
    'Filters' => [
        [
            'Key' => '<string>', // REQUIRED
            'Type' => 'Equal|NotEqual|LessThan|GreaterThan', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PatchGroup' => '<string>', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of InstancePatchStateFilter structures

Each entry in the array is a structure containing:

Key (string between 1 and 200 characters)

Values (array containing a single string)

Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")

MaxResults

Type: int

The maximum number of patches to return (per page).

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

PatchGroup

Required: Yes
Type: string

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

Result Syntax

[
    'InstancePatchStates' => [
        [
            'BaselineId' => '<string>',
            'CriticalNonCompliantCount' => <integer>,
            'FailedCount' => <integer>,
            'InstallOverrideList' => '<string>',
            'InstalledCount' => <integer>,
            'InstalledOtherCount' => <integer>,
            'InstalledPendingRebootCount' => <integer>,
            'InstalledRejectedCount' => <integer>,
            'InstanceId' => '<string>',
            'LastNoRebootInstallOperationTime' => <DateTime>,
            'MissingCount' => <integer>,
            'NotApplicableCount' => <integer>,
            'Operation' => 'Scan|Install',
            'OperationEndTime' => <DateTime>,
            'OperationStartTime' => <DateTime>,
            'OtherNonCompliantCount' => <integer>,
            'OwnerInformation' => '<string>',
            'PatchGroup' => '<string>',
            'RebootOption' => 'RebootIfNeeded|NoReboot',
            'SecurityNonCompliantCount' => <integer>,
            'SnapshotId' => '<string>',
            'UnreportedNotApplicableCount' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

InstancePatchStates

Type: Array of InstancePatchState structures

The high-level patch state for the requested instances.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidFilter:
The filter name is not valid. Verify the you entered the correct name and try again.
InvalidNextToken:
The specified token is not valid.

DescribeInstancePatches

$result = $client->describeInstancePatches([/* ... */]);
$promise = $client->describeInstancePatchesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeInstancePatches([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of PatchOrchestratorFilter structures

An array of structures. Each entry in the array is a structure containing a Key, Value combination. Valid values for Key are Classification | KBId | Severity | State.

InstanceId

Required: Yes
Type: string

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

MaxResults

Type: int

The maximum number of patches to return (per page).

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'NextToken' => '<string>',
    'Patches' => [
        [
            'CVEIds' => '<string>',
            'Classification' => '<string>',
            'InstalledTime' => <DateTime>,
            'KBId' => '<string>',
            'Severity' => '<string>',
            'State' => 'INSTALLED|INSTALLED_OTHER|INSTALLED_PENDING_REBOOT|INSTALLED_REJECTED|MISSING|NOT_APPLICABLE|FAILED',
            'Title' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Patches

Type: Array of PatchComplianceData structures

Each entry in the array is a structure containing:

Title (string)

KBId (string)

Classification (string)

Severity (string)

State (string, such as "INSTALLED" or "FAILED")

InstalledTime (DateTime)

InstalledBy (string)

Errors

InternalServerError:
An error occurred on the server side.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilter:
The filter name is not valid. Verify the you entered the correct name and try again.
InvalidNextToken:
The specified token is not valid.

DescribeInventoryDeletions

$result = $client->describeInventoryDeletions([/* ... */]);
$promise = $client->describeInventoryDeletionsAsync([/* ... */]);

Describes a specific delete inventory operation.

Parameter Syntax

$result = $client->describeInventoryDeletions([
    'DeletionId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DeletionId

Type: string

Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory action.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'InventoryDeletions' => [
        [
            'DeletionId' => '<string>',
            'DeletionStartTime' => <DateTime>,
            'DeletionSummary' => [
                'RemainingCount' => <integer>,
                'SummaryItems' => [
                    [
                        'Count' => <integer>,
                        'RemainingCount' => <integer>,
                        'Version' => '<string>',
                    ],
                    // ...
                ],
                'TotalCount' => <integer>,
            ],
            'LastStatus' => 'InProgress|Complete',
            'LastStatusMessage' => '<string>',
            'LastStatusUpdateTime' => <DateTime>,
            'TypeName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

InventoryDeletions

Type: Array of InventoryDeletionStatusItem structures

A list of status items for deleted inventory.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDeletionIdException:
The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.
InvalidNextToken:
The specified token is not valid.

DescribeMaintenanceWindowExecutionTaskInvocations

$result = $client->describeMaintenanceWindowExecutionTaskInvocations([/* ... */]);
$promise = $client->describeMaintenanceWindowExecutionTaskInvocationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeMaintenanceWindowExecutionTaskInvocations([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TaskId' => '<string>', // REQUIRED
    'WindowExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of MaintenanceWindowFilter structures

Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

TaskId

Required: Yes
Type: string

The ID of the specific task in the maintenance window task that should be retrieved.

WindowExecutionId

Required: Yes
Type: string

The ID of the maintenance window execution the task is part of.

Result Syntax

[
    'NextToken' => '<string>',
    'WindowExecutionTaskInvocationIdentities' => [
        [
            'EndTime' => <DateTime>,
            'ExecutionId' => '<string>',
            'InvocationId' => '<string>',
            'OwnerInformation' => '<string>',
            'Parameters' => '<string>',
            'StartTime' => <DateTime>,
            'Status' => 'PENDING|IN_PROGRESS|SUCCESS|FAILED|TIMED_OUT|CANCELLING|CANCELLED|SKIPPED_OVERLAPPING',
            'StatusDetails' => '<string>',
            'TaskExecutionId' => '<string>',
            'TaskType' => 'RUN_COMMAND|AUTOMATION|STEP_FUNCTIONS|LAMBDA',
            'WindowExecutionId' => '<string>',
            'WindowTargetId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

WindowExecutionTaskInvocationIdentities

Type: Array of MaintenanceWindowExecutionTaskInvocationIdentity structures

Information about the task invocation results per invocation.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

DescribeMaintenanceWindowExecutionTasks

$result = $client->describeMaintenanceWindowExecutionTasks([/* ... */]);
$promise = $client->describeMaintenanceWindowExecutionTasksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeMaintenanceWindowExecutionTasks([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WindowExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of MaintenanceWindowFilter structures

Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

WindowExecutionId

Required: Yes
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'WindowExecutionTaskIdentities' => [
        [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
            'Status' => 'PENDING|IN_PROGRESS|SUCCESS|FAILED|TIMED_OUT|CANCELLING|CANCELLED|SKIPPED_OVERLAPPING',
            'StatusDetails' => '<string>',
            'TaskArn' => '<string>',
            'TaskExecutionId' => '<string>',
            'TaskType' => 'RUN_COMMAND|AUTOMATION|STEP_FUNCTIONS|LAMBDA',
            'WindowExecutionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

WindowExecutionTaskIdentities

Type: Array of MaintenanceWindowExecutionTaskIdentity structures

Information about the task executions.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

DescribeMaintenanceWindowExecutions

$result = $client->describeMaintenanceWindowExecutions([/* ... */]);
$promise = $client->describeMaintenanceWindowExecutionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeMaintenanceWindowExecutions([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WindowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of MaintenanceWindowFilter structures

Each entry in the array is a structure containing:

Key (string, between 1 and 128 characters)

Values (array of strings, each string is between 1 and 256 characters)

The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

WindowId

Required: Yes
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'WindowExecutions' => [
        [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
            'Status' => 'PENDING|IN_PROGRESS|SUCCESS|FAILED|TIMED_OUT|CANCELLING|CANCELLED|SKIPPED_OVERLAPPING',
            'StatusDetails' => '<string>',
            'WindowExecutionId' => '<string>',
            'WindowId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

WindowExecutions

Type: Array of MaintenanceWindowExecution structures

Information about the maintenance window executions.

Errors

InternalServerError:
An error occurred on the server side.

DescribeMaintenanceWindowSchedule

$result = $client->describeMaintenanceWindowSchedule([/* ... */]);
$promise = $client->describeMaintenanceWindowScheduleAsync([/* ... */]);

Retrieves information about upcoming executions of a maintenance window.

Parameter Syntax

$result = $client->describeMaintenanceWindowSchedule([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => 'INSTANCE|RESOURCE_GROUP',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'WindowId' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of PatchOrchestratorFilter structures

Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

ResourceType

Type: string

The type of resource you want to retrieve information about. For example, "INSTANCE".

Targets

Type: Array of Target structures

The instance ID or key/value pair to retrieve information about.

WindowId

Type: string

The ID of the maintenance window to retrieve information about.

Result Syntax

[
    'NextToken' => '<string>',
    'ScheduledWindowExecutions' => [
        [
            'ExecutionTime' => '<string>',
            'Name' => '<string>',
            'WindowId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. (You use this token in the next call.)

ScheduledWindowExecutions

Type: Array of ScheduledWindowExecution structures

Information about maintenance window executions scheduled for the specified time range.

Errors

InternalServerError:
An error occurred on the server side.
DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.

DescribeMaintenanceWindowTargets

$result = $client->describeMaintenanceWindowTargets([/* ... */]);
$promise = $client->describeMaintenanceWindowTargetsAsync([/* ... */]);

Lists the targets registered with the maintenance window.

Parameter Syntax

$result = $client->describeMaintenanceWindowTargets([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WindowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of MaintenanceWindowFilter structures

Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

WindowId

Required: Yes
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Targets' => [
        [
            'Description' => '<string>',
            'Name' => '<string>',
            'OwnerInformation' => '<string>',
            'ResourceType' => 'INSTANCE|RESOURCE_GROUP',
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'WindowId' => '<string>',
            'WindowTargetId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Targets

Type: Array of MaintenanceWindowTarget structures

Information about the targets in the maintenance window.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

DescribeMaintenanceWindowTasks

$result = $client->describeMaintenanceWindowTasks([/* ... */]);
$promise = $client->describeMaintenanceWindowTasksAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeMaintenanceWindowTasks([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WindowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of MaintenanceWindowFilter structures

Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

WindowId

Required: Yes
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Tasks' => [
        [
            'Description' => '<string>',
            'LoggingInfo' => [
                'S3BucketName' => '<string>',
                'S3KeyPrefix' => '<string>',
                'S3Region' => '<string>',
            ],
            'MaxConcurrency' => '<string>',
            'MaxErrors' => '<string>',
            'Name' => '<string>',
            'Priority' => <integer>,
            'ServiceRoleArn' => '<string>',
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'TaskArn' => '<string>',
            'TaskParameters' => [
                '<MaintenanceWindowTaskParameterName>' => [
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'Type' => 'RUN_COMMAND|AUTOMATION|STEP_FUNCTIONS|LAMBDA',
            'WindowId' => '<string>',
            'WindowTaskId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Tasks

Type: Array of MaintenanceWindowTask structures

Information about the tasks in the maintenance window.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

DescribeMaintenanceWindows

$result = $client->describeMaintenanceWindows([/* ... */]);
$promise = $client->describeMaintenanceWindowsAsync([/* ... */]);

Retrieves the maintenance windows in an AWS account.

Parameter Syntax

$result = $client->describeMaintenanceWindows([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of MaintenanceWindowFilter structures

Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'NextToken' => '<string>',
    'WindowIdentities' => [
        [
            'Cutoff' => <integer>,
            'Description' => '<string>',
            'Duration' => <integer>,
            'Enabled' => true || false,
            'EndDate' => '<string>',
            'Name' => '<string>',
            'NextExecutionTime' => '<string>',
            'Schedule' => '<string>',
            'ScheduleOffset' => <integer>,
            'ScheduleTimezone' => '<string>',
            'StartDate' => '<string>',
            'WindowId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

WindowIdentities

Type: Array of MaintenanceWindowIdentity structures

Information about the maintenance windows.

Errors

InternalServerError:
An error occurred on the server side.

DescribeMaintenanceWindowsForTarget

$result = $client->describeMaintenanceWindowsForTarget([/* ... */]);
$promise = $client->describeMaintenanceWindowsForTargetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeMaintenanceWindowsForTarget([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => 'INSTANCE|RESOURCE_GROUP', // REQUIRED
    'Targets' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

ResourceType

Required: Yes
Type: string

The type of resource you want to retrieve information about. For example, "INSTANCE".

Targets

Required: Yes
Type: Array of Target structures

The instance ID or key/value pair to retrieve information about.

Result Syntax

[
    'NextToken' => '<string>',
    'WindowIdentities' => [
        [
            'Name' => '<string>',
            'WindowId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. (You use this token in the next call.)

WindowIdentities

Type: Array of MaintenanceWindowIdentityForTarget structures

Information about the maintenance window targets and tasks an instance is associated with.

Errors

InternalServerError:
An error occurred on the server side.

DescribeOpsItems

$result = $client->describeOpsItems([/* ... */]);
$promise = $client->describeOpsItemsAsync([/* ... */]);

Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Parameter Syntax

$result = $client->describeOpsItems([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OpsItemFilters' => [
        [
            'Key' => 'Status|CreatedBy|Source|Priority|Title|OpsItemId|CreatedTime|LastModifiedTime|ActualStartTime|ActualEndTime|PlannedStartTime|PlannedEndTime|OperationalData|OperationalDataKey|OperationalDataValue|ResourceId|AutomationId|Category|Severity|OpsItemType|ChangeRequestByRequesterArn|ChangeRequestByRequesterName|ChangeRequestByApproverArn|ChangeRequestByApproverName|ChangeRequestByTemplate|ChangeRequestByTargetsResourceGroup', // REQUIRED
            'Operator' => 'Equal|Contains|GreaterThan|LessThan', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

OpsItemFilters

Type: Array of OpsItemFilter structures

One or more filters to limit the response.

Key: CreatedTime

Operations: GreaterThan, LessThan
Key: LastModifiedBy

Operations: Contains, Equals
Key: LastModifiedTime

Operations: GreaterThan, LessThan
Key: Priority

Operations: Equals
Key: Source

Operations: Contains, Equals
Key: Status

Operations: Equals
Key: Title

Operations: Contains
Key: OperationalData*

Operations: Equals
Key: OperationalDataKey

Operations: Equals
Key: OperationalDataValue

Operations: Equals, Contains
Key: OpsItemId

Operations: Equals
Key: ResourceId

Operations: Contains
Key: AutomationId

Operations: Equals

*If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

Result Syntax

[
    'NextToken' => '<string>',
    'OpsItemSummaries' => [
        [
            'ActualEndTime' => <DateTime>,
            'ActualStartTime' => <DateTime>,
            'Category' => '<string>',
            'CreatedBy' => '<string>',
            'CreatedTime' => <DateTime>,
            'LastModifiedBy' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'OperationalData' => [
                '<OpsItemDataKey>' => [
                    'Type' => 'SearchableString|String',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'OpsItemId' => '<string>',
            'OpsItemType' => '<string>',
            'PlannedEndTime' => <DateTime>,
            'PlannedStartTime' => <DateTime>,
            'Priority' => <integer>,
            'Severity' => '<string>',
            'Source' => '<string>',
            'Status' => 'Open|InProgress|Resolved|Pending|TimedOut|Cancelling|Cancelled|Failed|CompletedWithSuccess|CompletedWithFailure|Scheduled|RunbookInProgress|PendingChangeCalendarOverride|ChangeCalendarOverrideApproved|ChangeCalendarOverrideRejected|PendingApproval|Approved|Rejected',
            'Title' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

OpsItemSummaries

Type: Array of OpsItemSummary structures

A list of OpsItems.

Errors

InternalServerError:
An error occurred on the server side.

DescribeParameters

$result = $client->describeParameters([/* ... */]);
$promise = $client->describeParametersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeParameters([
    'Filters' => [
        [
            'Key' => 'Name|Type|KeyId', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ParameterFilters' => [
        [
            'Key' => '<string>', // REQUIRED
            'Option' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members

Filters

Type: Array of ParametersFilter structures

This data type is deprecated. Instead, use ParameterFilters.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

ParameterFilters

Type: Array of ParameterStringFilter structures

Filters to limit the request results.

Result Syntax

[
    'NextToken' => '<string>',
    'Parameters' => [
        [
            'AllowedPattern' => '<string>',
            'DataType' => '<string>',
            'Description' => '<string>',
            'KeyId' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'LastModifiedUser' => '<string>',
            'Name' => '<string>',
            'Policies' => [
                [
                    'PolicyStatus' => '<string>',
                    'PolicyText' => '<string>',
                    'PolicyType' => '<string>',
                ],
                // ...
            ],
            'Tier' => 'Standard|Advanced|Intelligent-Tiering',
            'Type' => 'String|StringList|SecureString',
            'Version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items.

Parameters

Type: Array of ParameterMetadata structures

Parameters returned by the request.

Errors

InternalServerError:
An error occurred on the server side.
InvalidFilterKey:
The specified key is not valid.
InvalidFilterOption:
The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
InvalidFilterValue:
The filter value is not valid. Verify the value and try again.
InvalidNextToken:
The specified token is not valid.

DescribePatchBaselines

$result = $client->describePatchBaselines([/* ... */]);
$promise = $client->describePatchBaselinesAsync([/* ... */]);

Lists the patch baselines in your AWS account.

Parameter Syntax

$result = $client->describePatchBaselines([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of PatchOrchestratorFilter structures

Each element in the array is a structure containing:

Key: (string, "NAME_PREFIX" or "OWNER")

Value: (array of strings, exactly 1 entry, between 1 and 255 characters)

MaxResults

Type: int

The maximum number of patch baselines to return (per page).

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'BaselineIdentities' => [
        [
            'BaselineDescription' => '<string>',
            'BaselineId' => '<string>',
            'BaselineName' => '<string>',
            'DefaultBaseline' => true || false,
            'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

BaselineIdentities

Type: Array of PatchBaselineIdentity structures

An array of PatchBaselineIdentity elements.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.

DescribePatchGroupState

$result = $client->describePatchGroupState([/* ... */]);
$promise = $client->describePatchGroupStateAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describePatchGroupState([
    'PatchGroup' => '<string>', // REQUIRED
]);

Parameter Details

Members

PatchGroup

Required: Yes
Type: string

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

Result Syntax

[
    'Instances' => <integer>,
    'InstancesWithCriticalNonCompliantPatches' => <integer>,
    'InstancesWithFailedPatches' => <integer>,
    'InstancesWithInstalledOtherPatches' => <integer>,
    'InstancesWithInstalledPatches' => <integer>,
    'InstancesWithInstalledPendingRebootPatches' => <integer>,
    'InstancesWithInstalledRejectedPatches' => <integer>,
    'InstancesWithMissingPatches' => <integer>,
    'InstancesWithNotApplicablePatches' => <integer>,
    'InstancesWithOtherNonCompliantPatches' => <integer>,
    'InstancesWithSecurityNonCompliantPatches' => <integer>,
    'InstancesWithUnreportedNotApplicablePatches' => <integer>,
]

Result Details

Members

Instances

Type: int

The number of instances in the patch group.

InstancesWithCriticalNonCompliantPatches

Type: int

The number of instances where patches that are specified as "Critical" for compliance reporting in the patch baseline are not installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

InstancesWithFailedPatches

Type: int

The number of instances with patches from the patch baseline that failed to install.

InstancesWithInstalledOtherPatches

Type: int

The number of instances with patches installed that aren't defined in the patch baseline.

InstancesWithInstalledPatches

Type: int

The number of instances with installed patches.

InstancesWithInstalledPendingRebootPatches

Type: int

The number of instances with patches installed by Patch Manager that have not been rebooted after the patch installation. The status of these instances is NON_COMPLIANT.

InstancesWithInstalledRejectedPatches

Type: int

The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.

If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).

InstancesWithMissingPatches

Type: int

The number of instances with missing patches from the patch baseline.

InstancesWithNotApplicablePatches

Type: int

The number of instances with patches that aren't applicable.

InstancesWithOtherNonCompliantPatches

Type: int

The number of instances with patches installed that are specified as other than "Critical" or "Security" but are not compliant with the patch baseline. The status of these instances is NON_COMPLIANT.

InstancesWithSecurityNonCompliantPatches

Type: int

The number of instances where patches that are specified as "Security" in a patch advisory are not installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

InstancesWithUnreportedNotApplicablePatches

Type: int

The number of instances with NotApplicable patches beyond the supported limit, which are not reported by name to Systems Manager Inventory.

Errors

InternalServerError:
An error occurred on the server side.
InvalidNextToken:
The specified token is not valid.

DescribePatchGroups

$result = $client->describePatchGroups([/* ... */]);
$promise = $client->describePatchGroupsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describePatchGroups([
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of PatchOrchestratorFilter structures

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

For DescribePatchGroups,valid filter keys include the following:

NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.
OPERATING_SYSTEM: The supported operating system type to return results for. For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline.

Examples:
- --filters Key=NAME_PREFIX,Values=MyPatchGroup*
- --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2

MaxResults

Type: int

The maximum number of patch groups to return (per page).

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'Mappings' => [
        [
            'BaselineIdentity' => [
                'BaselineDescription' => '<string>',
                'BaselineId' => '<string>',
                'BaselineName' => '<string>',
                'DefaultBaseline' => true || false,
                'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS',
            ],
            'PatchGroup' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Mappings

Type: Array of PatchGroupPatchBaselineMapping structures

Each entry in the array contains:

PatchGroup: string (between 1 and 256 characters, Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$)

PatchBaselineIdentity: A PatchBaselineIdentity element.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.

DescribePatchProperties

$result = $client->describePatchProperties([/* ... */]);
$promise = $client->describePatchPropertiesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describePatchProperties([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS', // REQUIRED
    'PatchSet' => 'OS|APPLICATION',
    'Property' => 'PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|MSRC_SEVERITY|PRIORITY|SEVERITY', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

OperatingSystem

Required: Yes
Type: string

The operating system type for which to list patches.

PatchSet

Type: string

Indicates whether to list patches for the Windows operating system or for Microsoft applications. Not applicable for the Linux or macOS operating systems.

Property

Required: Yes
Type: string

The patch property for which you want to view patch details.

Result Syntax

[
    'NextToken' => '<string>',
    'Properties' => [
        ['<string>', ...],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. (You use this token in the next call.)

Properties

Type: Array of stringss

A list of the properties for patches matching the filter request parameters.

Errors

InternalServerError:
An error occurred on the server side.

DescribeSessions

$result = $client->describeSessions([/* ... */]);
$promise = $client->describeSessionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeSessions([
    'Filters' => [
        [
            'key' => 'InvokedAfter|InvokedBefore|Target|Owner|Status|SessionId', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'State' => 'Active|History', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of SessionFilter structures

One or more filters to limit the type of sessions returned by the request.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

State

Required: Yes
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Sessions' => [
        [
            'Details' => '<string>',
            'DocumentName' => '<string>',
            'EndDate' => <DateTime>,
            'OutputUrl' => [
                'CloudWatchOutputUrl' => '<string>',
                'S3OutputUrl' => '<string>',
            ],
            'Owner' => '<string>',
            'SessionId' => '<string>',
            'StartDate' => <DateTime>,
            'Status' => 'Connected|Connecting|Disconnected|Terminated|Terminating|Failed',
            'Target' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Sessions

Type: Array of Session structures

A list of sessions meeting the request parameters.

Errors

InternalServerError:
An error occurred on the server side.
InvalidFilterKey:
The specified key is not valid.
InvalidNextToken:
The specified token is not valid.

GetAutomationExecution

$result = $client->getAutomationExecution([/* ... */]);
$promise = $client->getAutomationExecutionAsync([/* ... */]);

Get detailed information about a particular Automation execution.

Parameter Syntax

$result = $client->getAutomationExecution([
    'AutomationExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AutomationExecutionId

Required: Yes
Type: string

The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated.

Result Syntax

[
    'AutomationExecution' => [
        'AssociationId' => '<string>',
        'AutomationExecutionId' => '<string>',
        'AutomationExecutionStatus' => 'Pending|InProgress|Waiting|Success|TimedOut|Cancelling|Cancelled|Failed|PendingApproval|Approved|Rejected|Scheduled|RunbookInProgress|PendingChangeCalendarOverride|ChangeCalendarOverrideApproved|ChangeCalendarOverrideRejected|CompletedWithSuccess|CompletedWithFailure',
        'AutomationSubtype' => 'ChangeRequest',
        'ChangeRequestName' => '<string>',
        'CurrentAction' => '<string>',
        'CurrentStepName' => '<string>',
        'DocumentName' => '<string>',
        'DocumentVersion' => '<string>',
        'ExecutedBy' => '<string>',
        'ExecutionEndTime' => <DateTime>,
        'ExecutionStartTime' => <DateTime>,
        'FailureMessage' => '<string>',
        'MaxConcurrency' => '<string>',
        'MaxErrors' => '<string>',
        'Mode' => 'Auto|Interactive',
        'OpsItemId' => '<string>',
        'Outputs' => [
            '<AutomationParameterKey>' => ['<string>', ...],
            // ...
        ],
        'Parameters' => [
            '<AutomationParameterKey>' => ['<string>', ...],
            // ...
        ],
        'ParentAutomationExecutionId' => '<string>',
        'ProgressCounters' => [
            'CancelledSteps' => <integer>,
            'FailedSteps' => <integer>,
            'SuccessSteps' => <integer>,
            'TimedOutSteps' => <integer>,
            'TotalSteps' => <integer>,
        ],
        'ResolvedTargets' => [
            'ParameterValues' => ['<string>', ...],
            'Truncated' => true || false,
        ],
        'Runbooks' => [
            [
                'DocumentName' => '<string>',
                'DocumentVersion' => '<string>',
                'MaxConcurrency' => '<string>',
                'MaxErrors' => '<string>',
                'Parameters' => [
                    '<AutomationParameterKey>' => ['<string>', ...],
                    // ...
                ],
                'TargetLocations' => [
                    [
                        'Accounts' => ['<string>', ...],
                        'ExecutionRoleName' => '<string>',
                        'Regions' => ['<string>', ...],
                        'TargetLocationMaxConcurrency' => '<string>',
                        'TargetLocationMaxErrors' => '<string>',
                    ],
                    // ...
                ],
                'TargetParameterName' => '<string>',
                'Targets' => [
                    [
                        'Key' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'ScheduledTime' => <DateTime>,
        'StepExecutions' => [
            [
                'Action' => '<string>',
                'ExecutionEndTime' => <DateTime>,
                'ExecutionStartTime' => <DateTime>,
                'FailureDetails' => [
                    'Details' => [
                        '<AutomationParameterKey>' => ['<string>', ...],
                        // ...
                    ],
                    'FailureStage' => '<string>',
                    'FailureType' => '<string>',
                ],
                'FailureMessage' => '<string>',
                'Inputs' => ['<string>', ...],
                'IsCritical' => true || false,
                'IsEnd' => true || false,
                'MaxAttempts' => <integer>,
                'NextStep' => '<string>',
                'OnFailure' => '<string>',
                'Outputs' => [
                    '<AutomationParameterKey>' => ['<string>', ...],
                    // ...
                ],
                'OverriddenParameters' => [
                    '<AutomationParameterKey>' => ['<string>', ...],
                    // ...
                ],
                'Response' => '<string>',
                'ResponseCode' => '<string>',
                'StepExecutionId' => '<string>',
                'StepName' => '<string>',
                'StepStatus' => 'Pending|InProgress|Waiting|Success|TimedOut|Cancelling|Cancelled|Failed|PendingApproval|Approved|Rejected|Scheduled|RunbookInProgress|PendingChangeCalendarOverride|ChangeCalendarOverrideApproved|ChangeCalendarOverrideRejected|CompletedWithSuccess|CompletedWithFailure',
                'TargetLocation' => [
                    'Accounts' => ['<string>', ...],
                    'ExecutionRoleName' => '<string>',
                    'Regions' => ['<string>', ...],
                    'TargetLocationMaxConcurrency' => '<string>',
                    'TargetLocationMaxErrors' => '<string>',
                ],
                'Targets' => [
                    [
                        'Key' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'TimeoutSeconds' => <integer>,
                'ValidNextSteps' => ['<string>', ...],
            ],
            // ...
        ],
        'StepExecutionsTruncated' => true || false,
        'Target' => '<string>',
        'TargetLocations' => [
            [
                'Accounts' => ['<string>', ...],
                'ExecutionRoleName' => '<string>',
                'Regions' => ['<string>', ...],
                'TargetLocationMaxConcurrency' => '<string>',
                'TargetLocationMaxErrors' => '<string>',
            ],
            // ...
        ],
        'TargetMaps' => [
            [
                '<TargetMapKey>' => ['<string>', ...],
                // ...
            ],
            // ...
        ],
        'TargetParameterName' => '<string>',
        'Targets' => [
            [
                'Key' => '<string>',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Members

AutomationExecution

Type: AutomationExecution structure

Detailed information about the current state of an automation execution.

Errors

AutomationExecutionNotFoundException:
There is no automation execution information for the requested automation execution ID.
InternalServerError:
An error occurred on the server side.

GetCalendarState

$result = $client->getCalendarState([/* ... */]);
$promise = $client->getCalendarStateAsync([/* ... */]);

Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time, GetCalendarState returns the state of the calendar at a specific time, and returns the next time that the Change Calendar state will transition. If you do not specify a time, GetCalendarState assumes the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.

Parameter Syntax

$result = $client->getCalendarState([
    'AtTime' => '<string>',
    'CalendarNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

AtTime

Type: string

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

CalendarNames

Required: Yes
Type: Array of strings

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

Result Syntax

[
    'AtTime' => '<string>',
    'NextTransitionTime' => '<string>',
    'State' => 'OPEN|CLOSED',
]

Result Details

Members

AtTime

Type: string

The time, as an ISO 8601 string, that you specified in your command. If you did not specify a time, GetCalendarState uses the current time.

NextTransitionTime

Type: string

The time, as an ISO 8601 string, that the calendar state will change. If the current calendar state is OPEN, NextTransitionTime indicates when the calendar state changes to CLOSED, and vice-versa.

State

Type: string

The state of the calendar. An OPEN calendar indicates that actions are allowed to proceed, and a CLOSED calendar indicates that actions are not allowed to proceed.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidDocumentType:
The document type is not valid. Valid document types are described in the DocumentType property.
UnsupportedCalendarException:
The calendar entry contained in the specified Systems Manager document is not supported.

GetCommandInvocation

$result = $client->getCommandInvocation([/* ... */]);
$promise = $client->getCommandInvocationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getCommandInvocation([
    'CommandId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'PluginName' => '<string>',
]);

Parameter Details

Members

CommandId

Required: Yes
Type: string

(Required) The parent command ID of the invocation plugin.

InstanceId

Required: Yes
Type: string

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

PluginName

Type: string

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents. For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Result Syntax

[
    'CloudWatchOutputConfig' => [
        'CloudWatchLogGroupName' => '<string>',
        'CloudWatchOutputEnabled' => true || false,
    ],
    'CommandId' => '<string>',
    'Comment' => '<string>',
    'DocumentName' => '<string>',
    'DocumentVersion' => '<string>',
    'ExecutionElapsedTime' => '<string>',
    'ExecutionEndDateTime' => '<string>',
    'ExecutionStartDateTime' => '<string>',
    'InstanceId' => '<string>',
    'PluginName' => '<string>',
    'ResponseCode' => <integer>,
    'StandardErrorContent' => '<string>',
    'StandardErrorUrl' => '<string>',
    'StandardOutputContent' => '<string>',
    'StandardOutputUrl' => '<string>',
    'Status' => 'Pending|InProgress|Delayed|Success|Cancelled|TimedOut|Failed|Cancelling',
    'StatusDetails' => '<string>',
]

Result Details

Members

CloudWatchOutputConfig

Type: CloudWatchOutputConfig structure

CloudWatch Logs information where Systems Manager sent the command output.

CommandId

Type: string

The parent command ID of the invocation plugin.

Comment

Type: string

The comment text for the command.

DocumentName

Type: string

The name of the document that was run. For example, AWS-RunShellScript.

DocumentVersion

Type: string

The SSM document version used in the request.

ExecutionElapsedTime

Type: string

Duration since ExecutionStartDateTime.

ExecutionEndDateTime

Type: string

The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter.

aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z

If the plugin has not started to run, the string is empty.

ExecutionStartDateTime

Type: string

The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter.

aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z

If the plugin has not started to run, the string is empty.

InstanceId

Type: string

The ID of the managed instance targeted by the command. A managed instance can be an EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

PluginName

Type: string

The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.

ResponseCode

Type: int

The error level response code for the plugin script. If the response code is -1, then the command has not started running on the instance, or it was not received by the instance.

StandardErrorContent

Type: string

The first 8,000 characters written by the plugin to stderr. If the command has not finished running, then this string is empty.

StandardErrorUrl

Type: string

The URL for the complete text written by the plugin to stderr. If the command has not finished running, then this string is empty.

StandardOutputContent

Type: string

The first 24,000 characters written by the plugin to stdout. If the command has not finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.

StandardOutputUrl

Type: string

The URL for the complete text written by the plugin to stdout in Amazon Simple Storage Service (Amazon S3). If an S3 bucket was not specified, then this string is empty.

Status

Type: string

The status of this invocation plugin. This status can be different than StatusDetails.

StatusDetails

Type: string

A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

Pending: The command has not been sent to the instance.
In Progress: The command has been sent to the instance but has not reached a terminal state.
Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, because the instance was stopped, or for similar reasons. The system will try to send the command again.
Success: The command or plugin ran successfully. This is a terminal state.
Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: The command started to run on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't run successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

Errors

InternalServerError:
An error occurred on the server side.
InvalidCommandId:
This error does not currently have a description.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidPluginName:
The plugin name is not valid.
InvocationDoesNotExist:
The command ID and instance ID you specified did not match any invocations. Verify the command ID and the instance ID and try again.

GetConnectionStatus

$result = $client->getConnectionStatus([/* ... */]);
$promise = $client->getConnectionStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getConnectionStatus([
    'Target' => '<string>', // REQUIRED
]);

Parameter Details

Members

Target

Required: Yes
Type: string

The ID of the instance.

Result Syntax

[
    'Status' => 'Connected|NotConnected',
    'Target' => '<string>',
]

Result Details

Members

Status

Type: string

The status of the connection to the instance. For example, 'Connected' or 'Not Connected'.

Target

Type: string

The ID of the instance to check connection status.

Errors

InternalServerError:
An error occurred on the server side.

GetDefaultPatchBaseline

$result = $client->getDefaultPatchBaseline([/* ... */]);
$promise = $client->getDefaultPatchBaselineAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getDefaultPatchBaseline([
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS',
]);

Parameter Details

Members

OperatingSystem

Type: string

Returns the default patch baseline for the specified operating system.

Result Syntax

[
    'BaselineId' => '<string>',
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS',
]

Result Details

Members

BaselineId

Type: string

The ID of the default patch baseline.

OperatingSystem

Type: string

The operating system for the returned patch baseline.

Errors

InternalServerError:
An error occurred on the server side.

GetDeployablePatchSnapshotForInstance

$result = $client->getDeployablePatchSnapshotForInstance([/* ... */]);
$promise = $client->getDeployablePatchSnapshotForInstanceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getDeployablePatchSnapshotForInstance([
    'BaselineOverride' => [
        'ApprovalRules' => [
            'PatchRules' => [ // REQUIRED
                [
                    'ApproveAfterDays' => <integer>,
                    'ApproveUntilDate' => '<string>',
                    'ComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
                    'EnableNonSecurity' => true || false,
                    'PatchFilterGroup' => [ // REQUIRED
                        'PatchFilters' => [ // REQUIRED
                            [
                                'Key' => 'ARCH|ADVISORY_ID|BUGZILLA_ID|PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|CVE_ID|EPOCH|MSRC_SEVERITY|NAME|PATCH_ID|SECTION|PRIORITY|REPOSITORY|RELEASE|SEVERITY|SECURITY|VERSION', // REQUIRED
                                'Values' => ['<string>', ...], // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                // ...
            ],
        ],
        'ApprovedPatches' => ['<string>', ...],
        'ApprovedPatchesComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
        'ApprovedPatchesEnableNonSecurity' => true || false,
        'GlobalFilters' => [
            'PatchFilters' => [ // REQUIRED
                [
                    'Key' => 'ARCH|ADVISORY_ID|BUGZILLA_ID|PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|CVE_ID|EPOCH|MSRC_SEVERITY|NAME|PATCH_ID|SECTION|PRIORITY|REPOSITORY|RELEASE|SEVERITY|SECURITY|VERSION', // REQUIRED
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS',
        'RejectedPatches' => ['<string>', ...],
        'RejectedPatchesAction' => 'ALLOW_AS_DEPENDENCY|BLOCK',
        'Sources' => [
            [
                'Configuration' => '<string>', // REQUIRED
                'Name' => '<string>', // REQUIRED
                'Products' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
    'InstanceId' => '<string>', // REQUIRED
    'SnapshotId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BaselineOverride

Type: BaselineOverride structure

Defines the basic information about a patch baseline override.

InstanceId

Required: Yes
Type: string

The ID of the instance for which the appropriate patch snapshot should be retrieved.

SnapshotId

Required: Yes
Type: string

The user-defined snapshot ID.

Result Syntax

[
    'InstanceId' => '<string>',
    'Product' => '<string>',
    'SnapshotDownloadUrl' => '<string>',
    'SnapshotId' => '<string>',
]

Result Details

Members

InstanceId

Type: string

The ID of the instance.

Product

Type: string

Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified patch snapshot.

SnapshotDownloadUrl

Type: string

A pre-signed Amazon S3 URL that can be used to download the patch snapshot.

SnapshotId

Type: string

The user-defined snapshot ID.

Errors

InternalServerError:
An error occurred on the server side.
UnsupportedOperatingSystem:
The operating systems you specified is not supported, or the operation is not supported for the operating system.
UnsupportedFeatureRequiredException:
Microsoft application patching is only available on EC2 instances and advanced instances. To patch Microsoft applications on on-premises servers and VMs, you must enable advanced instances. For more information, see Using the advanced-instances tier in the AWS Systems Manager User Guide.

GetDocument

$result = $client->getDocument([/* ... */]);
$promise = $client->getDocumentAsync([/* ... */]);

Gets the contents of the specified Systems Manager document.

Parameter Syntax

$result = $client->getDocument([
    'DocumentFormat' => 'YAML|JSON|TEXT',
    'DocumentVersion' => '<string>',
    'Name' => '<string>', // REQUIRED
    'VersionName' => '<string>',
]);

Parameter Details

Members

DocumentFormat

Type: string

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

DocumentVersion

Type: string

The document version for which you want information.

Name

Required: Yes
Type: string

The name of the Systems Manager document.

VersionName

Type: string

Result Syntax

[
    'AttachmentsContent' => [
        [
            'Hash' => '<string>',
            'HashType' => 'Sha256',
            'Name' => '<string>',
            'Size' => <integer>,
            'Url' => '<string>',
        ],
        // ...
    ],
    'Content' => '<string>',
    'DocumentFormat' => 'YAML|JSON|TEXT',
    'DocumentType' => 'Command|Policy|Automation|Session|Package|ApplicationConfiguration|ApplicationConfigurationSchema|DeploymentStrategy|ChangeCalendar|Automation.ChangeTemplate',
    'DocumentVersion' => '<string>',
    'Name' => '<string>',
    'Requires' => [
        [
            'Name' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'ReviewStatus' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
    'Status' => 'Creating|Active|Updating|Deleting|Failed',
    'StatusInformation' => '<string>',
    'VersionName' => '<string>',
]

Result Details

Members

AttachmentsContent

Type: Array of AttachmentContent structures

A description of the document attachments, including names, locations, sizes, and so on.

Content

Type: string

The contents of the Systems Manager document.

DocumentFormat

Type: string

The document format, either JSON or YAML.

DocumentType

Type: string

The document type.

DocumentVersion

Type: string

The document version.

Name

Type: string

The name of the Systems Manager document.

Requires

Type: Array of DocumentRequires structures

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

ReviewStatus

Type: string

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.

Status

Type: string

The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.

StatusInformation

Type: string

A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

VersionName

Type: string

The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidDocumentVersion:
The document version is not valid or does not exist.

GetInventory

$result = $client->getInventory([/* ... */]);
$promise = $client->getInventoryAsync([/* ... */]);

Query inventory information.

Parameter Syntax

$result = $client->getInventory([
    'Aggregators' => [
        [
            'Aggregators' => [...], // RECURSIVE
            'Expression' => '<string>',
            'Groups' => [
                [
                    'Filters' => [ // REQUIRED
                        [
                            'Key' => '<string>', // REQUIRED
                            'Type' => 'Equal|NotEqual|BeginWith|LessThan|GreaterThan|Exists',
                            'Values' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                    'Name' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Filters' => [
        [
            'Key' => '<string>', // REQUIRED
            'Type' => 'Equal|NotEqual|BeginWith|LessThan|GreaterThan|Exists',
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResultAttributes' => [
        [
            'TypeName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Aggregators

Type: Array of InventoryAggregator structures

Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and Linux instances exist in your inventoried fleet.

Filters

Type: Array of InventoryFilter structures

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

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

ResultAttributes

Type: Array of ResultAttribute structures

The list of inventory item types to return.

Result Syntax

[
    'Entities' => [
        [
            'Data' => [
                '<InventoryResultItemKey>' => [
                    'CaptureTime' => '<string>',
                    'Content' => [
                        ['<string>', ...],
                        // ...
                    ],
                    'ContentHash' => '<string>',
                    'SchemaVersion' => '<string>',
                    'TypeName' => '<string>',
                ],
                // ...
            ],
            'Id' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Entities

Type: Array of InventoryResultEntity structures

Collection of inventory entities such as a collection of instance inventory.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidFilter:
The filter name is not valid. Verify the you entered the correct name and try again.
InvalidInventoryGroupException:
The specified inventory group is not valid.
InvalidNextToken:
The specified token is not valid.
InvalidTypeNameException:
The parameter type name is not valid.
InvalidAggregatorException:
The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
InvalidResultAttributeException:
The specified inventory item result attribute is not valid.

GetInventorySchema

$result = $client->getInventorySchema([/* ... */]);
$promise = $client->getInventorySchemaAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getInventorySchema([
    'Aggregator' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SubType' => true || false,
    'TypeName' => '<string>',
]);

Parameter Details

Members

Aggregator

Type: boolean

Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

SubType

Type: boolean

Returns the sub-type schema for a specified inventory type.

TypeName

Type: string

The type of inventory item to return.

Result Syntax

[
    'NextToken' => '<string>',
    'Schemas' => [
        [
            'Attributes' => [
                [
                    'DataType' => 'string|number',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'DisplayName' => '<string>',
            'TypeName' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Schemas

Type: Array of InventoryItemSchema structures

Inventory schemas returned by the request.

Errors

InternalServerError:
An error occurred on the server side.
InvalidTypeNameException:
The parameter type name is not valid.
InvalidNextToken:
The specified token is not valid.

GetMaintenanceWindow

$result = $client->getMaintenanceWindow([/* ... */]);
$promise = $client->getMaintenanceWindowAsync([/* ... */]);

Retrieves a maintenance window.

Parameter Syntax

$result = $client->getMaintenanceWindow([
    'WindowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

WindowId

Required: Yes
Type: string

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

Result Syntax

[
    'AllowUnassociatedTargets' => true || false,
    'CreatedDate' => <DateTime>,
    'Cutoff' => <integer>,
    'Description' => '<string>',
    'Duration' => <integer>,
    'Enabled' => true || false,
    'EndDate' => '<string>',
    'ModifiedDate' => <DateTime>,
    'Name' => '<string>',
    'NextExecutionTime' => '<string>',
    'Schedule' => '<string>',
    'ScheduleOffset' => <integer>,
    'ScheduleTimezone' => '<string>',
    'StartDate' => '<string>',
    'WindowId' => '<string>',
]

Result Details

Members

AllowUnassociatedTargets

Type: boolean

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

CreatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the maintenance window was created.

Cutoff

Type: int

The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

Description

Type: string

The description of the maintenance window.

Duration

Type: int

The duration of the maintenance window in hours.

Enabled

Type: boolean

Indicates whether the maintenance window is enabled.

EndDate

Type: string

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.

ModifiedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the maintenance window was last modified.

Name

Type: string

The name of the maintenance window.

NextExecutionTime

Type: string

The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

Schedule

Type: string

The schedule of the maintenance window in the form of a cron or rate expression.

ScheduleOffset

Type: int

The number of days to wait to run a maintenance window after the scheduled CRON expression date and time.

ScheduleTimezone

Type: string

StartDate

Type: string

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.

WindowId

Type: string

The ID of the created maintenance window.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

GetMaintenanceWindowExecution

$result = $client->getMaintenanceWindowExecution([/* ... */]);
$promise = $client->getMaintenanceWindowExecutionAsync([/* ... */]);

Retrieves details about a specific a maintenance window execution.

Parameter Syntax

$result = $client->getMaintenanceWindowExecution([
    'WindowExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

WindowExecutionId

Required: Yes
Type: string

The ID of the maintenance window execution that includes the task.

Result Syntax

[
    'EndTime' => <DateTime>,
    'StartTime' => <DateTime>,
    'Status' => 'PENDING|IN_PROGRESS|SUCCESS|FAILED|TIMED_OUT|CANCELLING|CANCELLED|SKIPPED_OVERLAPPING',
    'StatusDetails' => '<string>',
    'TaskIds' => ['<string>', ...],
    'WindowExecutionId' => '<string>',
]

Result Details

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the maintenance window finished running.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the maintenance window started running.

Status

Type: string

The status of the maintenance window execution.

StatusDetails

Type: string

The details explaining the Status. Only available for certain status values.

TaskIds

Type: Array of strings

The ID of the task executions from the maintenance window execution.

WindowExecutionId

Type: string

The ID of the maintenance window execution.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

GetMaintenanceWindowExecutionTask

$result = $client->getMaintenanceWindowExecutionTask([/* ... */]);
$promise = $client->getMaintenanceWindowExecutionTaskAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getMaintenanceWindowExecutionTask([
    'TaskId' => '<string>', // REQUIRED
    'WindowExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

TaskId

Required: Yes
Type: string

The ID of the specific task execution in the maintenance window task that should be retrieved.

WindowExecutionId

Required: Yes
Type: string

The ID of the maintenance window execution that includes the task.

Result Syntax

[
    'EndTime' => <DateTime>,
    'MaxConcurrency' => '<string>',
    'MaxErrors' => '<string>',
    'Priority' => <integer>,
    'ServiceRole' => '<string>',
    'StartTime' => <DateTime>,
    'Status' => 'PENDING|IN_PROGRESS|SUCCESS|FAILED|TIMED_OUT|CANCELLING|CANCELLED|SKIPPED_OVERLAPPING',
    'StatusDetails' => '<string>',
    'TaskArn' => '<string>',
    'TaskExecutionId' => '<string>',
    'TaskParameters' => [
        [
            '<MaintenanceWindowTaskParameterName>' => [
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'Type' => 'RUN_COMMAND|AUTOMATION|STEP_FUNCTIONS|LAMBDA',
    'WindowExecutionId' => '<string>',
]

Result Details

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the task execution completed.

MaxConcurrency

Type: string

The defined maximum number of task executions that could be run in parallel.

MaxErrors

Type: string

The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

Priority

Type: int

The priority of the task.

ServiceRole

Type: string

The role that was assumed when running the task.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the task execution started.

Status

Type: string

The status of the task.

StatusDetails

Type: string

The details explaining the Status. Only available for certain status values.

TaskArn

Type: string

The ARN of the task that ran.

TaskExecutionId

Type: string

The ID of the specific task execution in the maintenance window task that was retrieved.

TaskParameters

Type: Array of MaintenanceWindowTaskParameterValueExpression structuress

The parameters passed to the task when it was run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Type

Type: string

The type of task that was run.

WindowExecutionId

Type: string

The ID of the maintenance window execution that includes the task.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

GetMaintenanceWindowExecutionTaskInvocation

$result = $client->getMaintenanceWindowExecutionTaskInvocation([/* ... */]);
$promise = $client->getMaintenanceWindowExecutionTaskInvocationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getMaintenanceWindowExecutionTaskInvocation([
    'InvocationId' => '<string>', // REQUIRED
    'TaskId' => '<string>', // REQUIRED
    'WindowExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InvocationId

Required: Yes
Type: string

The invocation ID to retrieve.

TaskId

Required: Yes
Type: string

The ID of the specific task in the maintenance window task that should be retrieved.

WindowExecutionId

Required: Yes
Type: string

The ID of the maintenance window execution for which the task is a part.

Result Syntax

[
    'EndTime' => <DateTime>,
    'ExecutionId' => '<string>',
    'InvocationId' => '<string>',
    'OwnerInformation' => '<string>',
    'Parameters' => '<string>',
    'StartTime' => <DateTime>,
    'Status' => 'PENDING|IN_PROGRESS|SUCCESS|FAILED|TIMED_OUT|CANCELLING|CANCELLED|SKIPPED_OVERLAPPING',
    'StatusDetails' => '<string>',
    'TaskExecutionId' => '<string>',
    'TaskType' => 'RUN_COMMAND|AUTOMATION|STEP_FUNCTIONS|LAMBDA',
    'WindowExecutionId' => '<string>',
    'WindowTargetId' => '<string>',
]

Result Details

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the task finished running on the target.

ExecutionId

Type: string

The execution ID.

InvocationId

Type: string

The invocation ID.

OwnerInformation

Type: string

User-provided value to be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Parameters

Type: string

The parameters used at the time that the task ran.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the task started running on the target.

Status

Type: string

The task status for an invocation.

StatusDetails

Type: string

The details explaining the status. Details are only available for certain status values.

TaskExecutionId

Type: string

The task execution ID.

TaskType

Type: string

Retrieves the task type for a maintenance window. Task types include the following: LAMBDA, STEP_FUNCTIONS, AUTOMATION, RUN_COMMAND.

WindowExecutionId

Type: string

The maintenance window execution ID.

WindowTargetId

Type: string

The maintenance window target ID.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

GetMaintenanceWindowTask

$result = $client->getMaintenanceWindowTask([/* ... */]);
$promise = $client->getMaintenanceWindowTaskAsync([/* ... */]);

Lists the tasks in a maintenance window.

Parameter Syntax

$result = $client->getMaintenanceWindowTask([
    'WindowId' => '<string>', // REQUIRED
    'WindowTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members

WindowId

Required: Yes
Type: string

The maintenance window ID that includes the task to retrieve.

WindowTaskId

Required: Yes
Type: string

The maintenance window task ID to retrieve.

Result Syntax

[
    'Description' => '<string>',
    'LoggingInfo' => [
        'S3BucketName' => '<string>',
        'S3KeyPrefix' => '<string>',
        'S3Region' => '<string>',
    ],
    'MaxConcurrency' => '<string>',
    'MaxErrors' => '<string>',
    'Name' => '<string>',
    'Priority' => <integer>,
    'ServiceRoleArn' => '<string>',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'TaskArn' => '<string>',
    'TaskInvocationParameters' => [
        'Automation' => [
            'DocumentVersion' => '<string>',
            'Parameters' => [
                '<AutomationParameterKey>' => ['<string>', ...],
                // ...
            ],
        ],
        'Lambda' => [
            'ClientContext' => '<string>',
            'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
            'Qualifier' => '<string>',
        ],
        'RunCommand' => [
            'CloudWatchOutputConfig' => [
                'CloudWatchLogGroupName' => '<string>',
                'CloudWatchOutputEnabled' => true || false,
            ],
            'Comment' => '<string>',
            'DocumentHash' => '<string>',
            'DocumentHashType' => 'Sha256|Sha1',
            'DocumentVersion' => '<string>',
            'NotificationConfig' => [
                'NotificationArn' => '<string>',
                'NotificationEvents' => ['<string>', ...],
                'NotificationType' => 'Command|Invocation',
            ],
            'OutputS3BucketName' => '<string>',
            'OutputS3KeyPrefix' => '<string>',
            'Parameters' => [
                '<ParameterName>' => ['<string>', ...],
                // ...
            ],
            'ServiceRoleArn' => '<string>',
            'TimeoutSeconds' => <integer>,
        ],
        'StepFunctions' => [
            'Input' => '<string>',
            'Name' => '<string>',
        ],
    ],
    'TaskParameters' => [
        '<MaintenanceWindowTaskParameterName>' => [
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'TaskType' => 'RUN_COMMAND|AUTOMATION|STEP_FUNCTIONS|LAMBDA',
    'WindowId' => '<string>',
    'WindowTaskId' => '<string>',
]

Result Details

Members

Description

Type: string

The retrieved task description.

LoggingInfo

Type: LoggingInfo structure

The location in Amazon S3 where the task results are logged.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

MaxConcurrency

Type: string

The maximum number of targets allowed to run this task in parallel.

For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value does not affect the running of your task and can be ignored.

MaxErrors

Type: string

The maximum number of errors allowed before the task stops being scheduled.

Name

Type: string

The retrieved task name.

Priority

Type: int

The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

ServiceRoleArn

Type: string

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

Targets

Type: Array of Target structures

The targets where the task should run.

TaskArn

Type: string

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

TaskInvocationParameters

Type: MaintenanceWindowTaskInvocationParameters structure

The parameters to pass to the task when it runs.

TaskParameters

Type: Associative array of custom strings keys (MaintenanceWindowTaskParameterName) to MaintenanceWindowTaskParameterValueExpression structures

The parameters to pass to the task when it runs.

TaskType

Type: string

The type of task to run.

WindowId

Type: string

The retrieved maintenance window ID.

WindowTaskId

Type: string

The retrieved maintenance window task ID.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

GetOpsItem

$result = $client->getOpsItem([/* ... */]);
$promise = $client->getOpsItemAsync([/* ... */]);

Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Parameter Syntax

$result = $client->getOpsItem([
    'OpsItemId' => '<string>', // REQUIRED
]);

Parameter Details

Members

OpsItemId

Required: Yes
Type: string

The ID of the OpsItem that you want to get.

Result Syntax

[
    'OpsItem' => [
        'ActualEndTime' => <DateTime>,
        'ActualStartTime' => <DateTime>,
        'Category' => '<string>',
        'CreatedBy' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'LastModifiedBy' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Notifications' => [
            [
                'Arn' => '<string>',
            ],
            // ...
        ],
        'OperationalData' => [
            '<OpsItemDataKey>' => [
                'Type' => 'SearchableString|String',
                'Value' => '<string>',
            ],
            // ...
        ],
        'OpsItemId' => '<string>',
        'OpsItemType' => '<string>',
        'PlannedEndTime' => <DateTime>,
        'PlannedStartTime' => <DateTime>,
        'Priority' => <integer>,
        'RelatedOpsItems' => [
            [
                'OpsItemId' => '<string>',
            ],
            // ...
        ],
        'Severity' => '<string>',
        'Source' => '<string>',
        'Status' => 'Open|InProgress|Resolved|Pending|TimedOut|Cancelling|Cancelled|Failed|CompletedWithSuccess|CompletedWithFailure|Scheduled|RunbookInProgress|PendingChangeCalendarOverride|ChangeCalendarOverrideApproved|ChangeCalendarOverrideRejected|PendingApproval|Approved|Rejected',
        'Title' => '<string>',
        'Version' => '<string>',
    ],
]

Result Details

Members

OpsItem

Type: OpsItem structure

The OpsItem.

Errors

InternalServerError:
An error occurred on the server side.
OpsItemNotFoundException:
The specified OpsItem ID doesn't exist. Verify the ID and try again.

GetOpsMetadata

$result = $client->getOpsMetadata([/* ... */]);
$promise = $client->getOpsMetadataAsync([/* ... */]);

View operational metadata related to an application in Application Manager.

Parameter Syntax

$result = $client->getOpsMetadata([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OpsMetadataArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

OpsMetadataArn

Required: Yes
Type: string

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

Result Syntax

[
    'Metadata' => [
        '<MetadataKey>' => [
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'ResourceId' => '<string>',
]

Result Details

Members

Metadata

Type: Associative array of custom strings keys (MetadataKey) to MetadataValue structures

OpsMetadata for an Application Manager application.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

ResourceId

Type: string

The resource ID of the Application Manager application.

Errors

OpsMetadataNotFoundException:
The OpsMetadata object does not exist.
OpsMetadataInvalidArgumentException:
One of the arguments passed is invalid.
InternalServerError:
An error occurred on the server side.

GetOpsSummary

$result = $client->getOpsSummary([/* ... */]);
$promise = $client->getOpsSummaryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getOpsSummary([
    'Aggregators' => [
        [
            'AggregatorType' => '<string>',
            'Aggregators' => [...], // RECURSIVE
            'AttributeName' => '<string>',
            'Filters' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Type' => 'Equal|NotEqual|BeginWith|LessThan|GreaterThan|Exists',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'TypeName' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'Filters' => [
        [
            'Key' => '<string>', // REQUIRED
            'Type' => 'Equal|NotEqual|BeginWith|LessThan|GreaterThan|Exists',
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResultAttributes' => [
        [
            'TypeName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'SyncName' => '<string>',
]);

Parameter Details

Members

Aggregators

Type: Array of OpsAggregator structures

Optional aggregators that return counts of OpsItems based on one or more expressions.

Filters

Type: Array of OpsFilter structures

Optional filters used to scope down the returned OpsItems.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

ResultAttributes

Type: Array of OpsResultAttribute structures

The OpsItem data type to return.

SyncName

Type: string

Specify the name of a resource data sync to get.

Result Syntax

[
    'Entities' => [
        [
            'Data' => [
                '<OpsEntityItemKey>' => [
                    'CaptureTime' => '<string>',
                    'Content' => [
                        ['<string>', ...],
                        // ...
                    ],
                ],
                // ...
            ],
            'Id' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Entities

Type: Array of OpsEntity structures

The list of aggregated and filtered OpsItems.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerError:
An error occurred on the server side.
ResourceDataSyncNotFoundException:
The specified sync name was not found.
InvalidFilter:
The filter name is not valid. Verify the you entered the correct name and try again.
InvalidNextToken:
The specified token is not valid.
InvalidTypeNameException:
The parameter type name is not valid.
InvalidAggregatorException:
The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.

GetParameter

$result = $client->getParameter([/* ... */]);
$promise = $client->getParameterAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getParameter([
    'Name' => '<string>', // REQUIRED
    'WithDecryption' => true || false,
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the parameter you want to query.

WithDecryption

Type: boolean

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

Result Syntax

[
    'Parameter' => [
        'ARN' => '<string>',
        'DataType' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'Name' => '<string>',
        'Selector' => '<string>',
        'SourceResult' => '<string>',
        'Type' => 'String|StringList|SecureString',
        'Value' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

Parameter

Type: Parameter structure

Information about a parameter.

Errors

InternalServerError:
An error occurred on the server side.
InvalidKeyId:
The query key ID is not valid.
ParameterNotFound:
The parameter could not be found. Verify the name and try again.
ParameterVersionNotFound:
The specified parameter version was not found. Verify the parameter name and version, and try again.

GetParameterHistory

$result = $client->getParameterHistory([/* ... */]);
$promise = $client->getParameterHistoryAsync([/* ... */]);

Retrieves the history of all changes to a parameter.

Parameter Syntax

$result = $client->getParameterHistory([
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'WithDecryption' => true || false,
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Name

Required: Yes
Type: string

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

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

WithDecryption

Type: boolean

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

Result Syntax

[
    'NextToken' => '<string>',
    'Parameters' => [
        [
            'AllowedPattern' => '<string>',
            'DataType' => '<string>',
            'Description' => '<string>',
            'KeyId' => '<string>',
            'Labels' => ['<string>', ...],
            'LastModifiedDate' => <DateTime>,
            'LastModifiedUser' => '<string>',
            'Name' => '<string>',
            'Policies' => [
                [
                    'PolicyStatus' => '<string>',
                    'PolicyText' => '<string>',
                    'PolicyType' => '<string>',
                ],
                // ...
            ],
            'Tier' => 'Standard|Advanced|Intelligent-Tiering',
            'Type' => 'String|StringList|SecureString',
            'Value' => '<string>',
            'Version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Parameters

Type: Array of ParameterHistory structures

A list of parameters returned by the request.

Errors

InternalServerError:
An error occurred on the server side.
ParameterNotFound:
The parameter could not be found. Verify the name and try again.
InvalidNextToken:
The specified token is not valid.
InvalidKeyId:
The query key ID is not valid.

GetParameters

$result = $client->getParameters([/* ... */]);
$promise = $client->getParametersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getParameters([
    'Names' => ['<string>', ...], // REQUIRED
    'WithDecryption' => true || false,
]);

Parameter Details

Members

Names

Required: Yes
Type: Array of strings

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

WithDecryption

Type: boolean

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

Result Syntax

[
    'InvalidParameters' => ['<string>', ...],
    'Parameters' => [
        [
            'ARN' => '<string>',
            'DataType' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'Selector' => '<string>',
            'SourceResult' => '<string>',
            'Type' => 'String|StringList|SecureString',
            'Value' => '<string>',
            'Version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

InvalidParameters

Type: Array of strings

A list of parameters that are not formatted correctly or do not run during an execution.

Parameters

Type: Array of Parameter structures

A list of details for a parameter.

Errors

InvalidKeyId:
The query key ID is not valid.
InternalServerError:
An error occurred on the server side.

GetParametersByPath

$result = $client->getParametersByPath([/* ... */]);
$promise = $client->getParametersByPathAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getParametersByPath([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ParameterFilters' => [
        [
            'Key' => '<string>', // REQUIRED
            'Option' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'Path' => '<string>', // REQUIRED
    'Recursive' => true || false,
    'WithDecryption' => true || false,
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

ParameterFilters

Type: Array of ParameterStringFilter structures

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

Path

Required: Yes
Type: string

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Recursive

Type: boolean

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.

WithDecryption

Type: boolean

Retrieve all parameters in a hierarchy with their value decrypted.

Result Syntax

[
    'NextToken' => '<string>',
    'Parameters' => [
        [
            'ARN' => '<string>',
            'DataType' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'Selector' => '<string>',
            'SourceResult' => '<string>',
            'Type' => 'String|StringList|SecureString',
            'Value' => '<string>',
            'Version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Parameters

Type: Array of Parameter structures

A list of parameters found in the specified hierarchy.

Errors

InternalServerError:
An error occurred on the server side.
InvalidFilterKey:
The specified key is not valid.
InvalidFilterOption:
The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
InvalidFilterValue:
The filter value is not valid. Verify the value and try again.
InvalidKeyId:
The query key ID is not valid.
InvalidNextToken:
The specified token is not valid.

GetPatchBaseline

$result = $client->getPatchBaseline([/* ... */]);
$promise = $client->getPatchBaselineAsync([/* ... */]);

Retrieves information about a patch baseline.

Parameter Syntax

$result = $client->getPatchBaseline([
    'BaselineId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BaselineId

Required: Yes
Type: string

The ID of the patch baseline to retrieve.

Result Syntax

[
    'ApprovalRules' => [
        'PatchRules' => [
            [
                'ApproveAfterDays' => <integer>,
                'ApproveUntilDate' => '<string>',
                'ComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
                'EnableNonSecurity' => true || false,
                'PatchFilterGroup' => [
                    'PatchFilters' => [
                        [
                            'Key' => 'ARCH|ADVISORY_ID|BUGZILLA_ID|PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|CVE_ID|EPOCH|MSRC_SEVERITY|NAME|PATCH_ID|SECTION|PRIORITY|REPOSITORY|RELEASE|SEVERITY|SECURITY|VERSION',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
    ],
    'ApprovedPatches' => ['<string>', ...],
    'ApprovedPatchesComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
    'ApprovedPatchesEnableNonSecurity' => true || false,
    'BaselineId' => '<string>',
    'CreatedDate' => <DateTime>,
    'Description' => '<string>',
    'GlobalFilters' => [
        'PatchFilters' => [
            [
                'Key' => 'ARCH|ADVISORY_ID|BUGZILLA_ID|PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|CVE_ID|EPOCH|MSRC_SEVERITY|NAME|PATCH_ID|SECTION|PRIORITY|REPOSITORY|RELEASE|SEVERITY|SECURITY|VERSION',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'ModifiedDate' => <DateTime>,
    'Name' => '<string>',
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS',
    'PatchGroups' => ['<string>', ...],
    'RejectedPatches' => ['<string>', ...],
    'RejectedPatchesAction' => 'ALLOW_AS_DEPENDENCY|BLOCK',
    'Sources' => [
        [
            'Configuration' => '<string>',
            'Name' => '<string>',
            'Products' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

ApprovalRules

Type: PatchRuleGroup structure

A set of rules used to include patches in the baseline.

ApprovedPatches

Type: Array of strings

A list of explicitly approved patches for the baseline.

ApprovedPatchesComplianceLevel

Type: string

Returns the specified compliance severity level for approved patches in the patch baseline.

ApprovedPatchesEnableNonSecurity

Type: boolean

Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

BaselineId

Type: string

The ID of the retrieved patch baseline.

CreatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the patch baseline was created.

Description

Type: string

A description of the patch baseline.

GlobalFilters

Type: PatchFilterGroup structure

A set of global filters used to exclude patches from the baseline.

ModifiedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the patch baseline was last modified.

Name

Type: string

The name of the patch baseline.

OperatingSystem

Type: string

Returns the operating system specified for the patch baseline.

PatchGroups

Type: Array of strings

Patch groups included in the patch baseline.

RejectedPatches

Type: Array of strings

A list of explicitly rejected patches for the baseline.

RejectedPatchesAction

Type: string

The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

Sources

Type: Array of PatchSource structures

Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.
InternalServerError:
An error occurred on the server side.

GetPatchBaselineForPatchGroup

$result = $client->getPatchBaselineForPatchGroup([/* ... */]);
$promise = $client->getPatchBaselineForPatchGroupAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getPatchBaselineForPatchGroup([
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS',
    'PatchGroup' => '<string>', // REQUIRED
]);

Parameter Details

Members

OperatingSystem

Type: string

Returns he operating system rule specified for patch groups using the patch baseline.

PatchGroup

Required: Yes
Type: string

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

Result Syntax

[
    'BaselineId' => '<string>',
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS|ORACLE_LINUX|DEBIAN|MACOS',
    'PatchGroup' => '<string>',
]

Result Details

Members

BaselineId

Type: string

The ID of the patch baseline that should be used for the patch group.

OperatingSystem

Type: string

The operating system rule specified for patch groups using the patch baseline.

PatchGroup

Type: string

The name of the patch group.

Errors

InternalServerError:
An error occurred on the server side.

GetServiceSetting

$result = $client->getServiceSetting([/* ... */]);
$promise = $client->getServiceSettingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getServiceSetting([
    'SettingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SettingId

Required: Yes
Type: string

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

Result Syntax

[
    'ServiceSetting' => [
        'ARN' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'LastModifiedUser' => '<string>',
        'SettingId' => '<string>',
        'SettingValue' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Members

ServiceSetting

Type: ServiceSetting structure

The query result of the current service setting.

Errors

InternalServerError:
An error occurred on the server side.
ServiceSettingNotFound:
The specified service setting was not found. Either the service name or the setting has not been provisioned by the AWS service team.

LabelParameterVersion

$result = $client->labelParameterVersion([/* ... */]);
$promise = $client->labelParameterVersionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->labelParameterVersion([
    'Labels' => ['<string>', ...], // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ParameterVersion' => <integer>,
]);

Parameter Details

Members

Labels

Required: Yes
Type: Array of strings

One or more labels to attach to the specified parameter version.

Name

Required: Yes
Type: string

The parameter name on which you want to attach one or more labels.

ParameterVersion

Type: long (int|float)

The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.

Result Syntax

[
    'InvalidLabels' => ['<string>', ...],
    'ParameterVersion' => <integer>,
]

Result Details

Members

InvalidLabels

Type: Array of strings

The label does not meet the requirements. For information about parameter label requirements, see Labeling parameters in the AWS Systems Manager User Guide.

ParameterVersion

Type: long (int|float)

The version of the parameter that has been labeled.

Errors

InternalServerError:
An error occurred on the server side.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.
ParameterNotFound:
The parameter could not be found. Verify the name and try again.
ParameterVersionNotFound:
The specified parameter version was not found. Verify the parameter name and version, and try again.
ParameterVersionLabelLimitExceeded:
A parameter version can have a maximum of ten labels.

ListAssociationVersions

$result = $client->listAssociationVersions([/* ... */]);
$promise = $client->listAssociationVersionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAssociationVersions([
    'AssociationId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AssociationId

Required: Yes
Type: string

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

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'AssociationVersions' => [
        [
            'ApplyOnlyAtCronInterval' => true || false,
            'AssociationId' => '<string>',
            'AssociationName' => '<string>',
            'AssociationVersion' => '<string>',
            'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
            'CreatedDate' => <DateTime>,
            'DocumentVersion' => '<string>',
            'MaxConcurrency' => '<string>',
            'MaxErrors' => '<string>',
            'Name' => '<string>',
            'OutputLocation' => [
                'S3Location' => [
                    'OutputS3BucketName' => '<string>',
                    'OutputS3KeyPrefix' => '<string>',
                    'OutputS3Region' => '<string>',
                ],
            ],
            'Parameters' => [
                '<ParameterName>' => ['<string>', ...],
                // ...
            ],
            'ScheduleExpression' => '<string>',
            'SyncCompliance' => 'AUTO|MANUAL',
            'TargetLocations' => [
                [
                    'Accounts' => ['<string>', ...],
                    'ExecutionRoleName' => '<string>',
                    'Regions' => ['<string>', ...],
                    'TargetLocationMaxConcurrency' => '<string>',
                    'TargetLocationMaxErrors' => '<string>',
                ],
                // ...
            ],
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AssociationVersions

Type: Array of AssociationVersionInfo structures

Information about all versions of the association for the specified association ID.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerError:
An error occurred on the server side.
InvalidNextToken:
The specified token is not valid.
AssociationDoesNotExist:
The specified association does not exist.

ListAssociations

$result = $client->listAssociations([/* ... */]);
$promise = $client->listAssociationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAssociations([
    'AssociationFilterList' => [
        [
            'key' => 'InstanceId|Name|AssociationId|AssociationStatusName|LastExecutedBefore|LastExecutedAfter|AssociationName|ResourceGroupName', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AssociationFilterList

Type: Array of AssociationFilter structures

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

Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the instance that are part of the Target Attributes ResourceGroup or Tags are not returned.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'Associations' => [
        [
            'AssociationId' => '<string>',
            'AssociationName' => '<string>',
            'AssociationVersion' => '<string>',
            'DocumentVersion' => '<string>',
            'InstanceId' => '<string>',
            'LastExecutionDate' => <DateTime>,
            'Name' => '<string>',
            'Overview' => [
                'AssociationStatusAggregatedCount' => [<integer>, ...],
                'DetailedStatus' => '<string>',
                'Status' => '<string>',
            ],
            'ScheduleExpression' => '<string>',
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Associations

Type: Array of Association structures

The associations.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidNextToken:
The specified token is not valid.

ListCommandInvocations

$result = $client->listCommandInvocations([/* ... */]);
$promise = $client->listCommandInvocationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listCommandInvocations([
    'CommandId' => '<string>',
    'Details' => true || false,
    'Filters' => [
        [
            'key' => 'InvokedAfter|InvokedBefore|Status|ExecutionStage|DocumentName', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'InstanceId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

CommandId

Type: string

(Optional) The invocations for a specific command ID.

Details

Type: boolean

(Optional) If set this returns the response of the command executions and any command output. The default value is 'false'.

Filters

Type: Array of CommandFilter structures

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

InstanceId

Type: string

(Optional) The command execution details for a specific instance ID.

MaxResults

Type: int

(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'CommandInvocations' => [
        [
            'CloudWatchOutputConfig' => [
                'CloudWatchLogGroupName' => '<string>',
                'CloudWatchOutputEnabled' => true || false,
            ],
            'CommandId' => '<string>',
            'CommandPlugins' => [
                [
                    'Name' => '<string>',
                    'Output' => '<string>',
                    'OutputS3BucketName' => '<string>',
                    'OutputS3KeyPrefix' => '<string>',
                    'OutputS3Region' => '<string>',
                    'ResponseCode' => <integer>,
                    'ResponseFinishDateTime' => <DateTime>,
                    'ResponseStartDateTime' => <DateTime>,
                    'StandardErrorUrl' => '<string>',
                    'StandardOutputUrl' => '<string>',
                    'Status' => 'Pending|InProgress|Success|TimedOut|Cancelled|Failed',
                    'StatusDetails' => '<string>',
                ],
                // ...
            ],
            'Comment' => '<string>',
            'DocumentName' => '<string>',
            'DocumentVersion' => '<string>',
            'InstanceId' => '<string>',
            'InstanceName' => '<string>',
            'NotificationConfig' => [
                'NotificationArn' => '<string>',
                'NotificationEvents' => ['<string>', ...],
                'NotificationType' => 'Command|Invocation',
            ],
            'RequestedDateTime' => <DateTime>,
            'ServiceRole' => '<string>',
            'StandardErrorUrl' => '<string>',
            'StandardOutputUrl' => '<string>',
            'Status' => 'Pending|InProgress|Delayed|Success|Cancelled|TimedOut|Failed|Cancelling',
            'StatusDetails' => '<string>',
            'TraceOutput' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

CommandInvocations

Type: Array of CommandInvocation structures

(Optional) A list of all invocations.

NextToken

Type: string

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

Errors

InternalServerError:
An error occurred on the server side.
InvalidCommandId:
This error does not currently have a description.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterKey:
The specified key is not valid.
InvalidNextToken:
The specified token is not valid.

ListCommands

$result = $client->listCommands([/* ... */]);
$promise = $client->listCommandsAsync([/* ... */]);

Lists the commands requested by users of the AWS account.

Parameter Syntax

$result = $client->listCommands([
    'CommandId' => '<string>',
    'Filters' => [
        [
            'key' => 'InvokedAfter|InvokedBefore|Status|ExecutionStage|DocumentName', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'InstanceId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

CommandId

Type: string

(Optional) If provided, lists only the specified command.

Filters

Type: Array of CommandFilter structures

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

InstanceId

Type: string

(Optional) Lists commands issued against this instance ID.

You can't specify an instance ID in the same command that you specify Status = Pending. This is because the command has not reached the instance yet.

MaxResults

Type: int

(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'Commands' => [
        [
            'CloudWatchOutputConfig' => [
                'CloudWatchLogGroupName' => '<string>',
                'CloudWatchOutputEnabled' => true || false,
            ],
            'CommandId' => '<string>',
            'Comment' => '<string>',
            'CompletedCount' => <integer>,
            'DeliveryTimedOutCount' => <integer>,
            'DocumentName' => '<string>',
            'DocumentVersion' => '<string>',
            'ErrorCount' => <integer>,
            'ExpiresAfter' => <DateTime>,
            'InstanceIds' => ['<string>', ...],
            'MaxConcurrency' => '<string>',
            'MaxErrors' => '<string>',
            'NotificationConfig' => [
                'NotificationArn' => '<string>',
                'NotificationEvents' => ['<string>', ...],
                'NotificationType' => 'Command|Invocation',
            ],
            'OutputS3BucketName' => '<string>',
            'OutputS3KeyPrefix' => '<string>',
            'OutputS3Region' => '<string>',
            'Parameters' => [
                '<ParameterName>' => ['<string>', ...],
                // ...
            ],
            'RequestedDateTime' => <DateTime>,
            'ServiceRole' => '<string>',
            'Status' => 'Pending|InProgress|Success|Cancelled|Failed|TimedOut|Cancelling',
            'StatusDetails' => '<string>',
            'TargetCount' => <integer>,
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'TimeoutSeconds' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Commands

Type: Array of Command structures

(Optional) The list of commands requested by the user.

NextToken

Type: string

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

Errors

InternalServerError:
An error occurred on the server side.
InvalidCommandId:
This error does not currently have a description.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterKey:
The specified key is not valid.
InvalidNextToken:
The specified token is not valid.

ListComplianceItems

$result = $client->listComplianceItems([/* ... */]);
$promise = $client->listComplianceItemsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listComplianceItems([
    'Filters' => [
        [
            'Key' => '<string>',
            'Type' => 'EQUAL|NOT_EQUAL|BEGIN_WITH|LESS_THAN|GREATER_THAN',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceIds' => ['<string>', ...],
    'ResourceTypes' => ['<string>', ...],
]);

Parameter Details

Members

Filters

Type: Array of ComplianceStringFilter structures

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

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

ResourceIds

Type: Array of strings

The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

ResourceTypes

Type: Array of strings

The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

Result Syntax

[
    'ComplianceItems' => [
        [
            'ComplianceType' => '<string>',
            'Details' => ['<string>', ...],
            'ExecutionSummary' => [
                'ExecutionId' => '<string>',
                'ExecutionTime' => <DateTime>,
                'ExecutionType' => '<string>',
            ],
            'Id' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
            'Severity' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
            'Status' => 'COMPLIANT|NON_COMPLIANT',
            'Title' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ComplianceItems

Type: Array of ComplianceItem structures

A list of compliance information for the specified resource ID.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InvalidResourceType:
The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.
InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.
InternalServerError:
An error occurred on the server side.
InvalidFilter:
The filter name is not valid. Verify the you entered the correct name and try again.
InvalidNextToken:
The specified token is not valid.

ListComplianceSummaries

$result = $client->listComplianceSummaries([/* ... */]);
$promise = $client->listComplianceSummariesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listComplianceSummaries([
    'Filters' => [
        [
            'Key' => '<string>',
            'Type' => 'EQUAL|NOT_EQUAL|BEGIN_WITH|LESS_THAN|GREATER_THAN',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of ComplianceStringFilter structures

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

MaxResults

Type: int

The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'ComplianceSummaryItems' => [
        [
            'ComplianceType' => '<string>',
            'CompliantSummary' => [
                'CompliantCount' => <integer>,
                'SeveritySummary' => [
                    'CriticalCount' => <integer>,
                    'HighCount' => <integer>,
                    'InformationalCount' => <integer>,
                    'LowCount' => <integer>,
                    'MediumCount' => <integer>,
                    'UnspecifiedCount' => <integer>,
                ],
            ],
            'NonCompliantSummary' => [
                'NonCompliantCount' => <integer>,
                'SeveritySummary' => [
                    'CriticalCount' => <integer>,
                    'HighCount' => <integer>,
                    'InformationalCount' => <integer>,
                    'LowCount' => <integer>,
                    'MediumCount' => <integer>,
                    'UnspecifiedCount' => <integer>,
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ComplianceSummaryItems

Type: Array of ComplianceSummaryItem structures

A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InvalidFilter:
The filter name is not valid. Verify the you entered the correct name and try again.
InvalidNextToken:
The specified token is not valid.
InternalServerError:
An error occurred on the server side.

ListDocumentMetadataHistory

$result = $client->listDocumentMetadataHistory([/* ... */]);
$promise = $client->listDocumentMetadataHistoryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDocumentMetadataHistory([
    'DocumentVersion' => '<string>',
    'MaxResults' => <integer>,
    'Metadata' => 'DocumentReviews', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members

DocumentVersion

Type: string

The version of the document.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Metadata

Required: Yes
Type: string

The type of data for which details are being requested. Currently, the only supported value is DocumentReviews.

Name

Required: Yes
Type: string

The name of the document.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'Author' => '<string>',
    'DocumentVersion' => '<string>',
    'Metadata' => [
        'ReviewerResponse' => [
            [
                'Comment' => [
                    [
                        'Content' => '<string>',
                        'Type' => 'Comment',
                    ],
                    // ...
                ],
                'CreateTime' => <DateTime>,
                'ReviewStatus' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
                'Reviewer' => '<string>',
                'UpdatedTime' => <DateTime>,
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'NextToken' => '<string>',
]

Result Details

Members

Author

Type: string

The user ID of the person in the organization who requested the document review.

DocumentVersion

Type: string

The version of the document.

Metadata

Type: DocumentMetadataResponseInfo structure

Information about the response to the document approval request.

Name

Type: string

The name of the document.

NextToken

Type: string

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidDocumentVersion:
The document version is not valid or does not exist.
InvalidNextToken:
The specified token is not valid.

ListDocumentVersions

$result = $client->listDocumentVersions([/* ... */]);
$promise = $client->listDocumentVersionsAsync([/* ... */]);

List all versions for a document.

Parameter Syntax

$result = $client->listDocumentVersions([
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Name

Required: Yes
Type: string

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

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'DocumentVersions' => [
        [
            'CreatedDate' => <DateTime>,
            'DocumentFormat' => 'YAML|JSON|TEXT',
            'DocumentVersion' => '<string>',
            'IsDefaultVersion' => true || false,
            'Name' => '<string>',
            'ReviewStatus' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
            'Status' => 'Creating|Active|Updating|Deleting|Failed',
            'StatusInformation' => '<string>',
            'VersionName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DocumentVersions

Type: Array of DocumentVersionInfo structures

The document versions.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidNextToken:
The specified token is not valid.
InvalidDocument:
The specified document does not exist.

ListDocuments

$result = $client->listDocuments([/* ... */]);
$promise = $client->listDocumentsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listDocuments([
    'DocumentFilterList' => [
        [
            'key' => 'Name|Owner|PlatformTypes|DocumentType', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Filters' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DocumentFilterList

Type: Array of DocumentFilter structures

This data type is deprecated. Instead, use Filters.

Filters

Type: Array of DocumentKeyValuesFilter structures

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API action only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'DocumentIdentifiers' => [
        [
            'Author' => '<string>',
            'DocumentFormat' => 'YAML|JSON|TEXT',
            'DocumentType' => 'Command|Policy|Automation|Session|Package|ApplicationConfiguration|ApplicationConfigurationSchema|DeploymentStrategy|ChangeCalendar|Automation.ChangeTemplate',
            'DocumentVersion' => '<string>',
            'Name' => '<string>',
            'Owner' => '<string>',
            'PlatformTypes' => ['<string>', ...],
            'Requires' => [
                [
                    'Name' => '<string>',
                    'Version' => '<string>',
                ],
                // ...
            ],
            'ReviewStatus' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
            'SchemaVersion' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TargetType' => '<string>',
            'VersionName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DocumentIdentifiers

Type: Array of DocumentIdentifier structures

The names of the Systems Manager documents.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidNextToken:
The specified token is not valid.
InvalidFilterKey:
The specified key is not valid.

ListInventoryEntries

$result = $client->listInventoryEntries([/* ... */]);
$promise = $client->listInventoryEntriesAsync([/* ... */]);

A list of inventory items returned by the request.

Parameter Syntax

$result = $client->listInventoryEntries([
    'Filters' => [
        [
            'Key' => '<string>', // REQUIRED
            'Type' => 'Equal|NotEqual|BeginWith|LessThan|GreaterThan|Exists',
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TypeName' => '<string>', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of InventoryFilter structures

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

InstanceId

Required: Yes
Type: string

The instance ID for which you want inventory information.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

The token for the next set of items to return. (You received this token from a previous call.)

TypeName

Required: Yes
Type: string

The type of inventory item for which you want information.

Result Syntax

[
    'CaptureTime' => '<string>',
    'Entries' => [
        ['<string>', ...],
        // ...
    ],
    'InstanceId' => '<string>',
    'NextToken' => '<string>',
    'SchemaVersion' => '<string>',
    'TypeName' => '<string>',
]

Result Details

Members

CaptureTime

Type: string

The time that inventory information was collected for the instance(s).

Entries

Type: Array of stringss

A list of inventory items on the instance(s).

InstanceId

Type: string

The instance ID targeted by the request to query inventory information.

NextToken

Type: string

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

SchemaVersion

Type: string

The inventory schema version used by the instance(s).

TypeName

Type: string

The type of inventory item returned by the request.

Errors

InternalServerError:
An error occurred on the server side.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidTypeNameException:
The parameter type name is not valid.
InvalidFilter:
The filter name is not valid. Verify the you entered the correct name and try again.
InvalidNextToken:
The specified token is not valid.

ListOpsItemEvents

$result = $client->listOpsItemEvents([/* ... */]);
$promise = $client->listOpsItemEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listOpsItemEvents([
    'Filters' => [
        [
            'Key' => 'OpsItemId', // REQUIRED
            'Operator' => 'Equal', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of OpsItemEventFilter structures

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

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'Summaries' => [
        [
            'CreatedBy' => [
                'Arn' => '<string>',
            ],
            'CreatedTime' => <DateTime>,
            'Detail' => '<string>',
            'DetailType' => '<string>',
            'EventId' => '<string>',
            'OpsItemId' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Summaries

Type: Array of OpsItemEventSummary structures

A list of event information for the specified OpsItems.

Errors

InternalServerError:
An error occurred on the server side.
OpsItemNotFoundException:
The specified OpsItem ID doesn't exist. Verify the ID and try again.
OpsItemLimitExceededException:
The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.
OpsItemInvalidParameterException:
A specified parameter argument isn't valid. Verify the available arguments and try again.

ListOpsMetadata

$result = $client->listOpsMetadata([/* ... */]);
$promise = $client->listOpsMetadataAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listOpsMetadata([
    'Filters' => [
        [
            'Key' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of OpsMetadataFilter structures

One or more filters to limit the number of OpsMetadata objects returned by the call.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'OpsMetadataList' => [
        [
            'CreationDate' => <DateTime>,
            'LastModifiedDate' => <DateTime>,
            'LastModifiedUser' => '<string>',
            'OpsMetadataArn' => '<string>',
            'ResourceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

OpsMetadataList

Type: Array of OpsMetadata structures

Returns a list of OpsMetadata objects.

Errors

OpsMetadataInvalidArgumentException:
One of the arguments passed is invalid.
InternalServerError:
An error occurred on the server side.

ListResourceComplianceSummaries

$result = $client->listResourceComplianceSummaries([/* ... */]);
$promise = $client->listResourceComplianceSummariesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listResourceComplianceSummaries([
    'Filters' => [
        [
            'Key' => '<string>',
            'Type' => 'EQUAL|NOT_EQUAL|BEGIN_WITH|LESS_THAN|GREATER_THAN',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of ComplianceStringFilter structures

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

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceComplianceSummaryItems' => [
        [
            'ComplianceType' => '<string>',
            'CompliantSummary' => [
                'CompliantCount' => <integer>,
                'SeveritySummary' => [
                    'CriticalCount' => <integer>,
                    'HighCount' => <integer>,
                    'InformationalCount' => <integer>,
                    'LowCount' => <integer>,
                    'MediumCount' => <integer>,
                    'UnspecifiedCount' => <integer>,
                ],
            ],
            'ExecutionSummary' => [
                'ExecutionId' => '<string>',
                'ExecutionTime' => <DateTime>,
                'ExecutionType' => '<string>',
            ],
            'NonCompliantSummary' => [
                'NonCompliantCount' => <integer>,
                'SeveritySummary' => [
                    'CriticalCount' => <integer>,
                    'HighCount' => <integer>,
                    'InformationalCount' => <integer>,
                    'LowCount' => <integer>,
                    'MediumCount' => <integer>,
                    'UnspecifiedCount' => <integer>,
                ],
            ],
            'OverallSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
            'Status' => 'COMPLIANT|NON_COMPLIANT',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

ResourceComplianceSummaryItems

Type: Array of ResourceComplianceSummaryItem structures

A summary count for specified or targeted managed instances. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.

Errors

InvalidFilter:
The filter name is not valid. Verify the you entered the correct name and try again.
InvalidNextToken:
The specified token is not valid.
InternalServerError:
An error occurred on the server side.

ListResourceDataSync

$result = $client->listResourceDataSync([/* ... */]);
$promise = $client->listResourceDataSyncAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listResourceDataSync([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SyncType' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

SyncType

Type: string

View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from AWS Organizations or from multiple AWS Regions.

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceDataSyncItems' => [
        [
            'LastStatus' => 'Successful|Failed|InProgress',
            'LastSuccessfulSyncTime' => <DateTime>,
            'LastSyncStatusMessage' => '<string>',
            'LastSyncTime' => <DateTime>,
            'S3Destination' => [
                'AWSKMSKeyARN' => '<string>',
                'BucketName' => '<string>',
                'DestinationDataSharing' => [
                    'DestinationDataSharingType' => '<string>',
                ],
                'Prefix' => '<string>',
                'Region' => '<string>',
                'SyncFormat' => 'JsonSerDe',
            ],
            'SyncCreatedTime' => <DateTime>,
            'SyncLastModifiedTime' => <DateTime>,
            'SyncName' => '<string>',
            'SyncSource' => [
                'AwsOrganizationsSource' => [
                    'OrganizationSourceType' => '<string>',
                    'OrganizationalUnits' => [
                        [
                            'OrganizationalUnitId' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'EnableAllOpsDataSources' => true || false,
                'IncludeFutureRegions' => true || false,
                'SourceRegions' => ['<string>', ...],
                'SourceType' => '<string>',
                'State' => '<string>',
            ],
            'SyncType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

ResourceDataSyncItems

Type: Array of ResourceDataSyncItem structures

A list of your current Resource Data Sync configurations and their statuses.

Errors

ResourceDataSyncInvalidConfigurationException:
The specified sync configuration is invalid.
InternalServerError:
An error occurred on the server side.
InvalidNextToken:
The specified token is not valid.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => 'Document|ManagedInstance|MaintenanceWindow|Parameter|PatchBaseline|OpsItem|OpsMetadata', // REQUIRED
]);

Parameter Details

Members

ResourceId

Required: Yes
Type: string

The resource ID for which you want to see a list of tags.

ResourceType

Required: Yes
Type: string

Returns a list of tags for a specific resource type.

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

TagList

Type: Array of Tag structures

A list of tags.

Errors

InvalidResourceType:
The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.
InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.
InternalServerError:
An error occurred on the server side.

ModifyDocumentPermission

$result = $client->modifyDocumentPermission([/* ... */]);
$promise = $client->modifyDocumentPermissionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->modifyDocumentPermission([
    'AccountIdsToAdd' => ['<string>', ...],
    'AccountIdsToRemove' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'PermissionType' => 'Share', // REQUIRED
    'SharedDocumentVersion' => '<string>',
]);

Parameter Details

Members

AccountIdsToAdd

Type: Array of strings

The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

AccountIdsToRemove

Type: Array of strings

The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.

Name

Required: Yes
Type: string

The name of the document that you want to share.

PermissionType

Required: Yes
Type: string

The permission type for the document. The permission type can be Share.

SharedDocumentVersion

Type: string

(Optional) The version of the document to share. If it's not specified, the system choose the Default version to share.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidPermissionType:
The permission type is not supported. Share is the only supported permission type.
DocumentPermissionLimit:
The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS Support.
DocumentLimitExceeded:
You can have at most 500 active Systems Manager documents.

PutComplianceItems

$result = $client->putComplianceItems([/* ... */]);
$promise = $client->putComplianceItemsAsync([/* ... */]);

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'

Parameter Syntax

$result = $client->putComplianceItems([
    'ComplianceType' => '<string>', // REQUIRED
    'ExecutionSummary' => [ // REQUIRED
        'ExecutionId' => '<string>',
        'ExecutionTime' => <integer || string || DateTime>, // REQUIRED
        'ExecutionType' => '<string>',
    ],
    'ItemContentHash' => '<string>',
    'Items' => [ // REQUIRED
        [
            'Details' => ['<string>', ...],
            'Id' => '<string>',
            'Severity' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED', // REQUIRED
            'Status' => 'COMPLIANT|NON_COMPLIANT', // REQUIRED
            'Title' => '<string>',
        ],
        // ...
    ],
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => '<string>', // REQUIRED
    'UploadType' => 'COMPLETE|PARTIAL',
]);

Parameter Details

Members

ComplianceType

Required: Yes
Type: string

Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

ExecutionSummary

Required: Yes
Type: ComplianceExecutionSummary structure

A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

ItemContentHash

Type: string

MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

Items

Required: Yes
Type: Array of ComplianceItemEntry structures

Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, and so on.

ResourceId

Required: Yes
Type: string

Specify an ID for this resource. For a managed instance, this is the instance ID.

ResourceType

Required: Yes
Type: string

Specify the type of resource. ManagedInstance is currently the only supported resource type.

UploadType

Type: string

The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

This attribute is only valid for association compliance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidItemContentException:
One or more content items is not valid.
TotalSizeLimitExceededException:
The size of inventory data has exceeded the total size limit for the resource.
ItemSizeLimitExceededException:
The inventory item size has exceeded the size limit.
ComplianceTypeCountLimitExceededException:
You specified too many custom compliance types. You can specify a maximum of 10 different types.
InvalidResourceType:
The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.
InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.

PutInventory

$result = $client->putInventory([/* ... */]);
$promise = $client->putInventoryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putInventory([
    'InstanceId' => '<string>', // REQUIRED
    'Items' => [ // REQUIRED
        [
            'CaptureTime' => '<string>', // REQUIRED
            'Content' => [
                ['<string>', ...],
                // ...
            ],
            'ContentHash' => '<string>',
            'Context' => ['<string>', ...],
            'SchemaVersion' => '<string>', // REQUIRED
            'TypeName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

An instance ID where you want to add or update inventory items.

Items

Required: Yes
Type: Array of InventoryItem structures

The inventory items that you want to add or update on instances.

Result Syntax

[
    'Message' => '<string>',
]

Result Details

Members

Message

Type: string

Information about the request.

Errors

InternalServerError:
An error occurred on the server side.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidTypeNameException:
The parameter type name is not valid.
InvalidItemContentException:
One or more content items is not valid.
TotalSizeLimitExceededException:
The size of inventory data has exceeded the total size limit for the resource.
ItemSizeLimitExceededException:
The inventory item size has exceeded the size limit.
ItemContentMismatchException:
The inventory item has invalid content.
CustomSchemaCountLimitExceededException:
You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.
UnsupportedInventorySchemaVersionException:
Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.
UnsupportedInventoryItemContextException:
The Context attribute that you specified for the InventoryItem is not allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem.
InvalidInventoryItemContextException:
You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again.
SubTypeCountLimitExceededException:
The sub-type count exceeded the limit for the inventory type.

PutParameter

$result = $client->putParameter([/* ... */]);
$promise = $client->putParameterAsync([/* ... */]);

Add a parameter to the system.

Parameter Syntax

$result = $client->putParameter([
    'AllowedPattern' => '<string>',
    'DataType' => '<string>',
    'Description' => '<string>',
    'KeyId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Overwrite' => true || false,
    'Policies' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tier' => 'Standard|Advanced|Intelligent-Tiering',
    'Type' => 'String|StringList|SecureString',
    'Value' => '<string>', // REQUIRED
]);

Parameter Details

Members

AllowedPattern

Type: string

A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$

DataType

Type: string

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.

The following data type values are supported.

text
aws:ec2:image

When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.

Description

Type: string

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

KeyId

Type: string

The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.

If you don't specify a key ID, the system uses the default key associated with your AWS account.

To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
To use a custom KMS key, choose the SecureString data type with the Key ID parameter.

Name

Required: Yes
Type: string

The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13

Naming Constraints:

Parameter names are case sensitive.
A parameter name must be unique within an AWS Region
A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-

In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: /Dev/Production/East/Project-ABC/MyParameter
A parameter name can't include spaces.
Parameter hierarchies are limited to a maximum depth of fifteen levels.

For additional information about valid values for parameter names, see Creating Systems Manager parameters in the AWS Systems Manager User Guide.

The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:

arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName

Overwrite

Type: boolean

Overwrite an existing parameter. The default value is 'false'.

Policies

Type: string

One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:

Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.

All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.

Tags

Type: Array of Tag structures

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:

Key=Resource,Value=S3bucket
Key=OS,Value=Windows
Key=ParameterType,Value=LicenseKey

To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.

Tier

Type: string

The parameter tier to assign to a parameter.

Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost.

Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the AWS Systems Manager User Guide.

You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.

If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.

Using the Default Tier Configuration

In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you do not specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.

The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:

Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.
Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.

If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.

This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.

Options that require an advanced parameter include the following:

The content size of the parameter is more than 4 KB.
The parameter uses a parameter policy.
More than 10,000 parameters already exist in your AWS account in the current Region.

For more information about configuring the default tier option, see Specifying a default parameter tier in the AWS Systems Manager User Guide.

Type

Type: string

The type of parameter that you want to add to the system.

SecureString is not currently supported for AWS CloudFormation templates.

Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.

Specifying a parameter type is not required when updating a parameter. You must specify a parameter type when creating a parameter.

Value

Required: Yes
Type: string

The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.

Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Result Syntax

[
    'Tier' => 'Standard|Advanced|Intelligent-Tiering',
    'Version' => <integer>,
]

Result Details

Members

Tier

Type: string

The tier assigned to the parameter.

Version

Type: long (int|float)

The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.

Errors

InternalServerError:
An error occurred on the server side.
InvalidKeyId:
The query key ID is not valid.
ParameterLimitExceeded:
You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try again.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.
ParameterAlreadyExists:
The parameter already exists. You can't create duplicate parameters.
HierarchyLevelLimitExceededException:
A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the AWS Systems Manager User Guide.
HierarchyTypeMismatchException:
Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.
InvalidAllowedPatternException:
The request does not meet the regular expression requirement.
ParameterMaxVersionLimitExceeded:
Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a label attached to it, Parameter Store will not delete the version and instead presents this error message:

An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.

This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the AWS Systems Manager User Guide.
ParameterPatternMismatchException:
The parameter name is not valid.
UnsupportedParameterType:
The parameter type is not supported.
PoliciesLimitExceededException:
You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.
InvalidPolicyTypeException:
The policy type is not supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
InvalidPolicyAttributeException:
A policy attribute or its value is invalid.
IncompatiblePolicyException:
There is a conflict in the policies specified for this parameter. You can't, for example, specify two Expiration policies for a parameter. Review your policies, and try again.

RegisterDefaultPatchBaseline

$result = $client->registerDefaultPatchBaseline([/* ... */]);
$promise = $client->registerDefaultPatchBaselineAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerDefaultPatchBaseline([
    'BaselineId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BaselineId

Required: Yes
Type: string

The ID of the patch baseline that should be the default patch baseline.

Result Syntax

[
    'BaselineId' => '<string>',
]

Result Details

Members

BaselineId

Type: string

The ID of the default patch baseline.

Errors

InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.
DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

RegisterPatchBaselineForPatchGroup

$result = $client->registerPatchBaselineForPatchGroup([/* ... */]);
$promise = $client->registerPatchBaselineForPatchGroupAsync([/* ... */]);

Registers a patch baseline for a patch group.

Parameter Syntax

$result = $client->registerPatchBaselineForPatchGroup([
    'BaselineId' => '<string>', // REQUIRED
    'PatchGroup' => '<string>', // REQUIRED
]);

Parameter Details

Members

BaselineId

Required: Yes
Type: string

The ID of the patch baseline to register the patch group with.

PatchGroup

Required: Yes
Type: string

The name of the patch group that should be registered with the patch baseline.

Result Syntax

[
    'BaselineId' => '<string>',
    'PatchGroup' => '<string>',
]

Result Details

Members

BaselineId

Type: string

The ID of the patch baseline the patch group was registered with.

PatchGroup

Type: string

The name of the patch group registered with the patch baseline.

Errors

AlreadyExistsException:
Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.
DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.
ResourceLimitExceededException:
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

RegisterTargetWithMaintenanceWindow

$result = $client->registerTargetWithMaintenanceWindow([/* ... */]);
$promise = $client->registerTargetWithMaintenanceWindowAsync([/* ... */]);

Registers a target with a maintenance window.

Parameter Syntax

$result = $client->registerTargetWithMaintenanceWindow([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>',
    'OwnerInformation' => '<string>',
    'ResourceType' => 'INSTANCE|RESOURCE_GROUP', // REQUIRED
    'Targets' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'WindowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientToken

Type: string

User-provided idempotency token.

Description

Type: string

An optional description for the target.

Name

Type: string

An optional name for the target.

OwnerInformation

Type: string

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

ResourceType

Required: Yes
Type: string

The type of target being registered with the maintenance window.

Targets

Required: Yes
Type: Array of Target structures

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

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

Example 3: Use tag-keys applied to instances

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

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

WindowId

Required: Yes
Type: string

The ID of the maintenance window the target should be registered with.

Result Syntax

[
    'WindowTargetId' => '<string>',
]

Result Details

Members

WindowTargetId

Type: string

The ID of the target definition in this maintenance window.

Errors

IdempotentParameterMismatch:
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
ResourceLimitExceededException:
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

RegisterTaskWithMaintenanceWindow

$result = $client->registerTaskWithMaintenanceWindow([/* ... */]);
$promise = $client->registerTaskWithMaintenanceWindowAsync([/* ... */]);

Adds a new task to a maintenance window.

Parameter Syntax

$result = $client->registerTaskWithMaintenanceWindow([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'LoggingInfo' => [
        'S3BucketName' => '<string>', // REQUIRED
        'S3KeyPrefix' => '<string>',
        'S3Region' => '<string>', // REQUIRED
    ],
    'MaxConcurrency' => '<string>',
    'MaxErrors' => '<string>',
    'Name' => '<string>',
    'Priority' => <integer>,
    'ServiceRoleArn' => '<string>',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'TaskArn' => '<string>', // REQUIRED
    'TaskInvocationParameters' => [
        'Automation' => [
            'DocumentVersion' => '<string>',
            'Parameters' => [
                '<AutomationParameterKey>' => ['<string>', ...],
                // ...
            ],
        ],
        'Lambda' => [
            'ClientContext' => '<string>',
            'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
            'Qualifier' => '<string>',
        ],
        'RunCommand' => [
            'CloudWatchOutputConfig' => [
                'CloudWatchLogGroupName' => '<string>',
                'CloudWatchOutputEnabled' => true || false,
            ],
            'Comment' => '<string>',
            'DocumentHash' => '<string>',
            'DocumentHashType' => 'Sha256|Sha1',
            'DocumentVersion' => '<string>',
            'NotificationConfig' => [
                'NotificationArn' => '<string>',
                'NotificationEvents' => ['<string>', ...],
                'NotificationType' => 'Command|Invocation',
            ],
            'OutputS3BucketName' => '<string>',
            'OutputS3KeyPrefix' => '<string>',
            'Parameters' => [
                '<ParameterName>' => ['<string>', ...],
                // ...
            ],
            'ServiceRoleArn' => '<string>',
            'TimeoutSeconds' => <integer>,
        ],
        'StepFunctions' => [
            'Input' => '<string>',
            'Name' => '<string>',
        ],
    ],
    'TaskParameters' => [
        '<MaintenanceWindowTaskParameterName>' => [
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'TaskType' => 'RUN_COMMAND|AUTOMATION|STEP_FUNCTIONS|LAMBDA', // REQUIRED
    'WindowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientToken

Type: string

User-provided idempotency token.

Description

Type: string

An optional description for the task.

LoggingInfo

Type: LoggingInfo structure

A structure containing information about an S3 bucket to write instance-level logs to.

MaxConcurrency

Type: string

The maximum number of targets this task can be run for in parallel.

For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.

MaxErrors

Type: string

The maximum number of errors allowed before this task stops being scheduled.

Name

Type: string

An optional name for the task.

Priority

Type: int

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

ServiceRoleArn

Type: string

The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Targets

Type: Array of Target structures

The targets (either instances or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

TaskArn

Required: Yes
Type: string

The ARN of the task to run.

TaskInvocationParameters

Type: MaintenanceWindowTaskInvocationParameters structure

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

TaskParameters

Type: Associative array of custom strings keys (MaintenanceWindowTaskParameterName) to MaintenanceWindowTaskParameterValueExpression structures

The parameters that should be passed to the task when it is run.

TaskType

Required: Yes
Type: string

The type of task being registered.

WindowId

Required: Yes
Type: string

The ID of the maintenance window the task should be added to.

Result Syntax

[
    'WindowTaskId' => '<string>',
]

Result Details

Members

WindowTaskId

Type: string

The ID of the task in the maintenance window.

Errors

IdempotentParameterMismatch:
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
ResourceLimitExceededException:
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
FeatureNotAvailableException:
You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service is not available.
InternalServerError:
An error occurred on the server side.

RemoveTagsFromResource

$result = $client->removeTagsFromResource([/* ... */]);
$promise = $client->removeTagsFromResourceAsync([/* ... */]);

Removes tag keys from the specified resource.

Parameter Syntax

$result = $client->removeTagsFromResource([
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => 'Document|ManagedInstance|MaintenanceWindow|Parameter|PatchBaseline|OpsItem|OpsMetadata', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceId

Required: Yes
Type: string

The ID of the resource from which you want to remove tags. For example:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

PatchBaseline: pb-012345abcde

For the Document and Parameter values, use the name of the resource.

The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

ResourceType

Required: Yes
Type: string

The type of resource from which you want to remove a tag.

The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

TagKeys

Required: Yes
Type: Array of strings

Tag keys that you want to remove from the specified resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidResourceType:
The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.
InvalidResourceId:
The resource ID is not valid. Verify that you entered the correct ID and try again.
InternalServerError:
An error occurred on the server side.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.

ResetServiceSetting

$result = $client->resetServiceSetting([/* ... */]);
$promise = $client->resetServiceSettingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->resetServiceSetting([
    'SettingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SettingId

Required: Yes
Type: string

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

Result Syntax

[
    'ServiceSetting' => [
        'ARN' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'LastModifiedUser' => '<string>',
        'SettingId' => '<string>',
        'SettingValue' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Members

ServiceSetting

Type: ServiceSetting structure

The current, effective service setting after calling the ResetServiceSetting API action.

Errors

InternalServerError:
An error occurred on the server side.
ServiceSettingNotFound:
The specified service setting was not found. Either the service name or the setting has not been provisioned by the AWS service team.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.

ResumeSession

$result = $client->resumeSession([/* ... */]);
$promise = $client->resumeSessionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->resumeSession([
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SessionId

Required: Yes
Type: string

The ID of the disconnected session to resume.

Result Syntax

[
    'SessionId' => '<string>',
    'StreamUrl' => '<string>',
    'TokenValue' => '<string>',
]

Result Details

Members

SessionId

Type: string

The ID of the session.

StreamUrl

Type: string

A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the AWS General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

TokenValue

Type: string

An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

SendAutomationSignal

$result = $client->sendAutomationSignal([/* ... */]);
$promise = $client->sendAutomationSignalAsync([/* ... */]);

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

Parameter Syntax

$result = $client->sendAutomationSignal([
    'AutomationExecutionId' => '<string>', // REQUIRED
    'Payload' => [
        '<AutomationParameterKey>' => ['<string>', ...],
        // ...
    ],
    'SignalType' => 'Approve|Reject|StartStep|StopStep|Resume', // REQUIRED
]);

Parameter Details

Members

AutomationExecutionId

Required: Yes
Type: string

The unique identifier for an existing Automation execution that you want to send the signal to.

Payload

Type: Associative array of custom strings keys (AutomationParameterKey) to stringss

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

SignalType

Required: Yes
Type: string

The type of signal to send to an Automation execution.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AutomationExecutionNotFoundException:
There is no automation execution information for the requested automation execution ID.
AutomationStepNotFoundException:
The specified step name and execution ID don't exist. Verify the information and try again.
InvalidAutomationSignalException:
The signal is not valid for the current Automation execution.
InternalServerError:
An error occurred on the server side.

SendCommand

$result = $client->sendCommand([/* ... */]);
$promise = $client->sendCommandAsync([/* ... */]);

Runs commands on one or more managed instances.

Parameter Syntax

$result = $client->sendCommand([
    'CloudWatchOutputConfig' => [
        'CloudWatchLogGroupName' => '<string>',
        'CloudWatchOutputEnabled' => true || false,
    ],
    'Comment' => '<string>',
    'DocumentHash' => '<string>',
    'DocumentHashType' => 'Sha256|Sha1',
    'DocumentName' => '<string>', // REQUIRED
    'DocumentVersion' => '<string>',
    'InstanceIds' => ['<string>', ...],
    'MaxConcurrency' => '<string>',
    'MaxErrors' => '<string>',
    'NotificationConfig' => [
        'NotificationArn' => '<string>',
        'NotificationEvents' => ['<string>', ...],
        'NotificationType' => 'Command|Invocation',
    ],
    'OutputS3BucketName' => '<string>',
    'OutputS3KeyPrefix' => '<string>',
    'OutputS3Region' => '<string>',
    'Parameters' => [
        '<ParameterName>' => ['<string>', ...],
        // ...
    ],
    'ServiceRoleArn' => '<string>',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'TimeoutSeconds' => <integer>,
]);

Parameter Details

Members

CloudWatchOutputConfig

Type: CloudWatchOutputConfig structure

Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

Comment

Type: string

User-specified information about the command, such as a brief description of what the command should do.

DocumentHash

Type: string

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

DocumentHashType

Type: string

Sha256 or Sha1.

Sha1 hashes have been deprecated.

DocumentName

Required: Yes
Type: string

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

DocumentVersion

Type: string

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

InstanceIds

Type: Array of strings

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the AWS Systems Manager User Guide.

MaxConcurrency

Type: string

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the AWS Systems Manager User Guide.

MaxErrors

Type: string

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the AWS Systems Manager User Guide.

NotificationConfig

Type: NotificationConfig structure

Configurations for sending notifications.

OutputS3BucketName

Type: string

The name of the S3 bucket where command execution responses should be stored.

OutputS3KeyPrefix

Type: string

The directory structure within the S3 bucket where the responses should be stored.

OutputS3Region

Type: string

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.

Parameters

Type: Associative array of custom strings keys (ParameterName) to stringss

The required and optional parameters specified in the document being run.

ServiceRoleArn

Type: string

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Targets

Type: Array of Target structures

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the AWS Systems Manager User Guide.

TimeoutSeconds

Type: int

If this time is reached and the command has not already started running, it will not run.

Result Syntax

[
    'Command' => [
        'CloudWatchOutputConfig' => [
            'CloudWatchLogGroupName' => '<string>',
            'CloudWatchOutputEnabled' => true || false,
        ],
        'CommandId' => '<string>',
        'Comment' => '<string>',
        'CompletedCount' => <integer>,
        'DeliveryTimedOutCount' => <integer>,
        'DocumentName' => '<string>',
        'DocumentVersion' => '<string>',
        'ErrorCount' => <integer>,
        'ExpiresAfter' => <DateTime>,
        'InstanceIds' => ['<string>', ...],
        'MaxConcurrency' => '<string>',
        'MaxErrors' => '<string>',
        'NotificationConfig' => [
            'NotificationArn' => '<string>',
            'NotificationEvents' => ['<string>', ...],
            'NotificationType' => 'Command|Invocation',
        ],
        'OutputS3BucketName' => '<string>',
        'OutputS3KeyPrefix' => '<string>',
        'OutputS3Region' => '<string>',
        'Parameters' => [
            '<ParameterName>' => ['<string>', ...],
            // ...
        ],
        'RequestedDateTime' => <DateTime>,
        'ServiceRole' => '<string>',
        'Status' => 'Pending|InProgress|Success|Cancelled|Failed|TimedOut|Cancelling',
        'StatusDetails' => '<string>',
        'TargetCount' => <integer>,
        'Targets' => [
            [
                'Key' => '<string>',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
        'TimeoutSeconds' => <integer>,
    ],
]

Result Details

Members

Command

Type: Command structure

The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.

Errors

DuplicateInstanceId:
You cannot specify an instance ID in more than one association.
InternalServerError:
An error occurred on the server side.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidDocument:
The specified document does not exist.
InvalidDocumentVersion:
The document version is not valid or does not exist.
InvalidOutputFolder:
The S3 bucket does not exist.
InvalidParameters:
You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.
UnsupportedPlatformType:
The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.
MaxDocumentSizeExceeded:
The size limit of a document is 64 KB.
InvalidRole:
The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.
InvalidNotificationConfig:
One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.

StartAssociationsOnce

$result = $client->startAssociationsOnce([/* ... */]);
$promise = $client->startAssociationsOnceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startAssociationsOnce([
    'AssociationIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

AssociationIds

Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidAssociation:
The association is not valid or does not exist.
AssociationDoesNotExist:
The specified association does not exist.

StartAutomationExecution

$result = $client->startAutomationExecution([/* ... */]);
$promise = $client->startAutomationExecutionAsync([/* ... */]);

Initiates execution of an Automation document.

Parameter Syntax

$result = $client->startAutomationExecution([
    'ClientToken' => '<string>',
    'DocumentName' => '<string>', // REQUIRED
    'DocumentVersion' => '<string>',
    'MaxConcurrency' => '<string>',
    'MaxErrors' => '<string>',
    'Mode' => 'Auto|Interactive',
    'Parameters' => [
        '<AutomationParameterKey>' => ['<string>', ...],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TargetLocations' => [
        [
            'Accounts' => ['<string>', ...],
            'ExecutionRoleName' => '<string>',
            'Regions' => ['<string>', ...],
            'TargetLocationMaxConcurrency' => '<string>',
            'TargetLocationMaxErrors' => '<string>',
        ],
        // ...
    ],
    'TargetMaps' => [
        [
            '<TargetMapKey>' => ['<string>', ...],
            // ...
        ],
        // ...
    ],
    'TargetParameterName' => '<string>',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientToken

Type: string

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

DocumentName

Required: Yes
Type: string

DocumentVersion

Type: string

The version of the Automation document to use for this execution.

MaxConcurrency

Type: string

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

MaxErrors

Type: string

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Mode

Type: string

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

Parameters

Type: Associative array of custom strings keys (AutomationParameterKey) to stringss

A key-value map of execution parameters, which match the declared parameters in the Automation document.

Tags

Type: Array of Tag structures

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key name/value pairs:

Key=environment,Value=test
Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource action.

TargetLocations

Type: Array of TargetLocation structures

A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple AWS Regions and accounts in the AWS Systems Manager User Guide.

TargetMaps

Type: Array of maps

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.

TargetParameterName

Type: string

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Targets

Type: Array of Target structures

A key-value mapping to target resources. Required if you specify TargetParameterName.

Result Syntax

[
    'AutomationExecutionId' => '<string>',
]

Result Details

Members

AutomationExecutionId

Type: string

The unique ID of a newly scheduled automation execution.

Errors

AutomationDefinitionNotFoundException:
An Automation document with the specified name could not be found.
InvalidAutomationExecutionParametersException:
The supplied parameters for invoking the specified Automation document are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
AutomationExecutionLimitExceededException:
The number of simultaneously running Automation executions exceeded the allowable limit.
AutomationDefinitionVersionNotFoundException:
An Automation document with the specified name and version could not be found.
IdempotentParameterMismatch:
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
InvalidTarget:
The target is not valid or does not exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
InternalServerError:
An error occurred on the server side.

StartChangeRequestExecution

$result = $client->startChangeRequestExecution([/* ... */]);
$promise = $client->startChangeRequestExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startChangeRequestExecution([
    'ChangeDetails' => '<string>',
    'ChangeRequestName' => '<string>',
    'ClientToken' => '<string>',
    'DocumentName' => '<string>', // REQUIRED
    'DocumentVersion' => '<string>',
    'Parameters' => [
        '<AutomationParameterKey>' => ['<string>', ...],
        // ...
    ],
    'Runbooks' => [ // REQUIRED
        [
            'DocumentName' => '<string>', // REQUIRED
            'DocumentVersion' => '<string>',
            'MaxConcurrency' => '<string>',
            'MaxErrors' => '<string>',
            'Parameters' => [
                '<AutomationParameterKey>' => ['<string>', ...],
                // ...
            ],
            'TargetLocations' => [
                [
                    'Accounts' => ['<string>', ...],
                    'ExecutionRoleName' => '<string>',
                    'Regions' => ['<string>', ...],
                    'TargetLocationMaxConcurrency' => '<string>',
                    'TargetLocationMaxErrors' => '<string>',
                ],
                // ...
            ],
            'TargetParameterName' => '<string>',
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'ScheduledEndTime' => <integer || string || DateTime>,
    'ScheduledTime' => <integer || string || DateTime>,
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ChangeDetails

Type: string

User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

ChangeRequestName

Type: string

The name of the change request associated with the runbook workflow to be run.

ClientToken

Type: string

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

DocumentName

Required: Yes
Type: string

The name of the change template document to run during the runbook workflow.

DocumentVersion

Type: string

The version of the change template document to run during the runbook workflow.

Parameters

Type: Associative array of custom strings keys (AutomationParameterKey) to stringss

A key-value map of parameters that match the declared parameters in the change template document.

Runbooks

Required: Yes
Type: Array of Runbook structures

Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

ScheduledEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

ScheduledTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Tags

Type: Array of Tag structures

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:

Key=Environment,Value=Production
Key=Region,Value=us-east-2

Result Syntax

[
    'AutomationExecutionId' => '<string>',
]

Result Details

Members

AutomationExecutionId

Type: string

The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)

Errors

AutomationDefinitionNotFoundException:
An Automation document with the specified name could not be found.
InvalidAutomationExecutionParametersException:
The supplied parameters for invoking the specified Automation document are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
AutomationExecutionLimitExceededException:
The number of simultaneously running Automation executions exceeded the allowable limit.
AutomationDefinitionVersionNotFoundException:
An Automation document with the specified name and version could not be found.
IdempotentParameterMismatch:
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
InternalServerError:
An error occurred on the server side.
AutomationDefinitionNotApprovedException:
Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.

StartSession

$result = $client->startSession([/* ... */]);
$promise = $client->startSessionAsync([/* ... */]);

Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the AWS CLI in the AWS Systems Manager User Guide.

AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.

Parameter Syntax

$result = $client->startSession([
    'DocumentName' => '<string>',
    'Parameters' => [
        '<SessionManagerParameterName>' => ['<string>', ...],
        // ...
    ],
    'Target' => '<string>', // REQUIRED
]);

Parameter Details

Members

DocumentName

Type: string

The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the instance is launched by default.

Parameters

Type: Associative array of custom strings keys (SessionManagerParameterName) to stringss

Reserved for future use.

Target

Required: Yes
Type: string

The instance to connect to for the session.

Result Syntax

[
    'SessionId' => '<string>',
    'StreamUrl' => '<string>',
    'TokenValue' => '<string>',
]

Result Details

Members

SessionId

Type: string

The ID of the session.

StreamUrl

Type: string

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

TokenValue

Type: string

An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.

Errors

InvalidDocument:
The specified document does not exist.
TargetNotConnected:
The specified target instance for the session is not fully configured for use with Session Manager. For more information, see Getting started with Session Manager in the AWS Systems Manager User Guide. This error is also returned if you attempt to start a session on an instance that is located in a different account or Region
InternalServerError:
An error occurred on the server side.

StopAutomationExecution

$result = $client->stopAutomationExecution([/* ... */]);
$promise = $client->stopAutomationExecutionAsync([/* ... */]);

Stop an Automation that is currently running.

Parameter Syntax

$result = $client->stopAutomationExecution([
    'AutomationExecutionId' => '<string>', // REQUIRED
    'Type' => 'Complete|Cancel',
]);

Parameter Details

Members

AutomationExecutionId

Required: Yes
Type: string

The execution ID of the Automation to stop.

Type

Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AutomationExecutionNotFoundException:
There is no automation execution information for the requested automation execution ID.
InvalidAutomationStatusUpdateException:
The specified update status operation is not valid.
InternalServerError:
An error occurred on the server side.

TerminateSession

$result = $client->terminateSession([/* ... */]);
$promise = $client->terminateSessionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->terminateSession([
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SessionId

Required: Yes
Type: string

The ID of the session to terminate.

Result Syntax

[
    'SessionId' => '<string>',
]

Result Details

Members

SessionId

Type: string

The ID of the session that has been terminated.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

UnlabelParameterVersion

$result = $client->unlabelParameterVersion([/* ... */]);
$promise = $client->unlabelParameterVersionAsync([/* ... */]);

Remove a label or labels from a parameter.

Parameter Syntax

$result = $client->unlabelParameterVersion([
    'Labels' => ['<string>', ...], // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ParameterVersion' => <integer>, // REQUIRED
]);

Parameter Details

Members

Labels

Required: Yes
Type: Array of strings

One or more labels to delete from the specified parameter version.

Name

Required: Yes
Type: string

The parameter name of which you want to delete one or more labels.

ParameterVersion

Required: Yes
Type: long (int|float)

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

Result Syntax

[
    'InvalidLabels' => ['<string>', ...],
    'RemovedLabels' => ['<string>', ...],
]

Result Details

Members

InvalidLabels

Type: Array of strings

The labels that are not attached to the given parameter version.

RemovedLabels

Type: Array of strings

A list of all labels deleted from the parameter.

Errors

InternalServerError:
An error occurred on the server side.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.
ParameterNotFound:
The parameter could not be found. Verify the name and try again.
ParameterVersionNotFound:
The specified parameter version was not found. Verify the parameter name and version, and try again.

UpdateAssociation

$result = $client->updateAssociation([/* ... */]);
$promise = $client->updateAssociationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateAssociation([
    'ApplyOnlyAtCronInterval' => true || false,
    'AssociationId' => '<string>', // REQUIRED
    'AssociationName' => '<string>',
    'AssociationVersion' => '<string>',
    'AutomationTargetParameterName' => '<string>',
    'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
    'DocumentVersion' => '<string>',
    'MaxConcurrency' => '<string>',
    'MaxErrors' => '<string>',
    'Name' => '<string>',
    'OutputLocation' => [
        'S3Location' => [
            'OutputS3BucketName' => '<string>',
            'OutputS3KeyPrefix' => '<string>',
            'OutputS3Region' => '<string>',
        ],
    ],
    'Parameters' => [
        '<ParameterName>' => ['<string>', ...],
        // ...
    ],
    'ScheduleExpression' => '<string>',
    'SyncCompliance' => 'AUTO|MANUAL',
    'TargetLocations' => [
        [
            'Accounts' => ['<string>', ...],
            'ExecutionRoleName' => '<string>',
            'Regions' => ['<string>', ...],
            'TargetLocationMaxConcurrency' => '<string>',
            'TargetLocationMaxErrors' => '<string>',
        ],
        // ...
    ],
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members

ApplyOnlyAtCronInterval

Type: boolean

By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter is not supported for rate expressions.

Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

AssociationId

Required: Yes
Type: string

The ID of the association you want to update.

AssociationName

Type: string

The name of the association that you want to update.

AssociationVersion

Type: string

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

AutomationTargetParameterName

Type: string

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

ComplianceSeverity

Type: string

The severity level to assign to the association.

DocumentVersion

Type: string

The document version you want update for the association.

MaxConcurrency

Type: string

MaxErrors

Type: string

Name

Type: string

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

arn:aws:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

OutputLocation

Type: InstanceAssociationOutputLocation structure

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

Parameters

Type: Associative array of custom strings keys (ParameterName) to stringss

The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}

ScheduleExpression

Type: string

The cron expression used to schedule the association that you want to update.

SyncCompliance

Type: string

By default, all associations use AUTO mode.

TargetLocations

Type: Array of TargetLocation structures

A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.

Targets

Type: Array of Target structures

The targets of the association.

Result Syntax

[
    'AssociationDescription' => [
        'ApplyOnlyAtCronInterval' => true || false,
        'AssociationId' => '<string>',
        'AssociationName' => '<string>',
        'AssociationVersion' => '<string>',
        'AutomationTargetParameterName' => '<string>',
        'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
        'Date' => <DateTime>,
        'DocumentVersion' => '<string>',
        'InstanceId' => '<string>',
        'LastExecutionDate' => <DateTime>,
        'LastSuccessfulExecutionDate' => <DateTime>,
        'LastUpdateAssociationDate' => <DateTime>,
        'MaxConcurrency' => '<string>',
        'MaxErrors' => '<string>',
        'Name' => '<string>',
        'OutputLocation' => [
            'S3Location' => [
                'OutputS3BucketName' => '<string>',
                'OutputS3KeyPrefix' => '<string>',
                'OutputS3Region' => '<string>',
            ],
        ],
        'Overview' => [
            'AssociationStatusAggregatedCount' => [<integer>, ...],
            'DetailedStatus' => '<string>',
            'Status' => '<string>',
        ],
        'Parameters' => [
            '<ParameterName>' => ['<string>', ...],
            // ...
        ],
        'ScheduleExpression' => '<string>',
        'Status' => [
            'AdditionalInfo' => '<string>',
            'Date' => <DateTime>,
            'Message' => '<string>',
            'Name' => 'Pending|Success|Failed',
        ],
        'SyncCompliance' => 'AUTO|MANUAL',
        'TargetLocations' => [
            [
                'Accounts' => ['<string>', ...],
                'ExecutionRoleName' => '<string>',
                'Regions' => ['<string>', ...],
                'TargetLocationMaxConcurrency' => '<string>',
                'TargetLocationMaxErrors' => '<string>',
            ],
            // ...
        ],
        'Targets' => [
            [
                'Key' => '<string>',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Members

AssociationDescription

Type: AssociationDescription structure

The description of the association that was updated.

Errors

InternalServerError:
An error occurred on the server side.
InvalidSchedule:
The schedule is invalid. Verify your cron or rate expression and try again.
InvalidParameters:
You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.
InvalidOutputLocation:
The output location is not valid or does not exist.
InvalidDocumentVersion:
The document version is not valid or does not exist.
AssociationDoesNotExist:
The specified association does not exist.
InvalidUpdate:
The update is not valid.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.
InvalidDocument:
The specified document does not exist.
InvalidTarget:
The target is not valid or does not exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
InvalidAssociationVersion:
The version you specified is not valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.
AssociationVersionLimitExceeded:
You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.

UpdateAssociationStatus

$result = $client->updateAssociationStatus([/* ... */]);
$promise = $client->updateAssociationStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateAssociationStatus([
    'AssociationStatus' => [ // REQUIRED
        'AdditionalInfo' => '<string>',
        'Date' => <integer || string || DateTime>, // REQUIRED
        'Message' => '<string>', // REQUIRED
        'Name' => 'Pending|Success|Failed', // REQUIRED
    ],
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AssociationStatus

Required: Yes
Type: AssociationStatus structure

The association status.

InstanceId

Required: Yes
Type: string

The ID of the instance.

Name

Required: Yes
Type: string

The name of the Systems Manager document.

Result Syntax

[
    'AssociationDescription' => [
        'ApplyOnlyAtCronInterval' => true || false,
        'AssociationId' => '<string>',
        'AssociationName' => '<string>',
        'AssociationVersion' => '<string>',
        'AutomationTargetParameterName' => '<string>',
        'ComplianceSeverity' => 'CRITICAL|HIGH|MEDIUM|LOW|UNSPECIFIED',
        'Date' => <DateTime>,
        'DocumentVersion' => '<string>',
        'InstanceId' => '<string>',
        'LastExecutionDate' => <DateTime>,
        'LastSuccessfulExecutionDate' => <DateTime>,
        'LastUpdateAssociationDate' => <DateTime>,
        'MaxConcurrency' => '<string>',
        'MaxErrors' => '<string>',
        'Name' => '<string>',
        'OutputLocation' => [
            'S3Location' => [
                'OutputS3BucketName' => '<string>',
                'OutputS3KeyPrefix' => '<string>',
                'OutputS3Region' => '<string>',
            ],
        ],
        'Overview' => [
            'AssociationStatusAggregatedCount' => [<integer>, ...],
            'DetailedStatus' => '<string>',
            'Status' => '<string>',
        ],
        'Parameters' => [
            '<ParameterName>' => ['<string>', ...],
            // ...
        ],
        'ScheduleExpression' => '<string>',
        'Status' => [
            'AdditionalInfo' => '<string>',
            'Date' => <DateTime>,
            'Message' => '<string>',
            'Name' => 'Pending|Success|Failed',
        ],
        'SyncCompliance' => 'AUTO|MANUAL',
        'TargetLocations' => [
            [
                'Accounts' => ['<string>', ...],
                'ExecutionRoleName' => '<string>',
                'Regions' => ['<string>', ...],
                'TargetLocationMaxConcurrency' => '<string>',
                'TargetLocationMaxErrors' => '<string>',
            ],
            // ...
        ],
        'Targets' => [
            [
                'Key' => '<string>',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Members

AssociationDescription

Type: AssociationDescription structure

Information about the association.

Errors

InternalServerError:
An error occurred on the server side.
InvalidInstanceId:
The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. Verify that SSM Agent is running.

SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidDocument:
The specified document does not exist.
AssociationDoesNotExist:
The specified association does not exist.
StatusUnchanged:
The updated status is the same as the current status.
TooManyUpdates:
There are concurrent updates for a resource that supports one update at a time.

UpdateDocument

$result = $client->updateDocument([/* ... */]);
$promise = $client->updateDocumentAsync([/* ... */]);

Updates one or more values for an SSM document.

Parameter Syntax

$result = $client->updateDocument([
    'Attachments' => [
        [
            'Key' => 'SourceUrl|S3FileUrl|AttachmentReference',
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'Content' => '<string>', // REQUIRED
    'DocumentFormat' => 'YAML|JSON|TEXT',
    'DocumentVersion' => '<string>',
    'Name' => '<string>', // REQUIRED
    'TargetType' => '<string>',
    'VersionName' => '<string>',
]);

Parameter Details

Members

Attachments

Type: Array of AttachmentsSource structures

A list of key and value pairs that describe attachments to a version of a document.

Content

Required: Yes
Type: string

A valid JSON or YAML string.

DocumentFormat

Type: string

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

DocumentVersion

Type: string

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

Name

Required: Yes
Type: string

The name of the document that you want to update.

TargetType

Type: string

Specify a new target type for the document.

VersionName

Type: string

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Result Syntax

[
    'DocumentDescription' => [
        'ApprovedVersion' => '<string>',
        'AttachmentsInformation' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'Author' => '<string>',
        'CreatedDate' => <DateTime>,
        'DefaultVersion' => '<string>',
        'Description' => '<string>',
        'DocumentFormat' => 'YAML|JSON|TEXT',
        'DocumentType' => 'Command|Policy|Automation|Session|Package|ApplicationConfiguration|ApplicationConfigurationSchema|DeploymentStrategy|ChangeCalendar|Automation.ChangeTemplate',
        'DocumentVersion' => '<string>',
        'Hash' => '<string>',
        'HashType' => 'Sha256|Sha1',
        'LatestVersion' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'Parameters' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'Name' => '<string>',
                'Type' => 'String|StringList',
            ],
            // ...
        ],
        'PendingReviewVersion' => '<string>',
        'PlatformTypes' => ['<string>', ...],
        'Requires' => [
            [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'ReviewInformation' => [
            [
                'ReviewedTime' => <DateTime>,
                'Reviewer' => '<string>',
                'Status' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
            ],
            // ...
        ],
        'ReviewStatus' => 'APPROVED|NOT_REVIEWED|PENDING|REJECTED',
        'SchemaVersion' => '<string>',
        'Sha1' => '<string>',
        'Status' => 'Creating|Active|Updating|Deleting|Failed',
        'StatusInformation' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TargetType' => '<string>',
        'VersionName' => '<string>',
    ],
]

Result Details

Members

DocumentDescription

Type: DocumentDescription structure

A description of the document that was updated.

Errors

MaxDocumentSizeExceeded:
The size limit of a document is 64 KB.
DocumentVersionLimitExceeded:
The document has too many versions. Delete one or more document versions and try again.
InternalServerError:
An error occurred on the server side.
DuplicateDocumentContent:
The content of the association document matches another document. Change the content of the document and try again.
DuplicateDocumentVersionName:
The version name has already been used in this document. Specify a different version name, and then try again.
InvalidDocumentContent:
The content for the document is not valid.
InvalidDocumentVersion:
The document version is not valid or does not exist.
InvalidDocumentSchemaVersion:
The version of the document schema is not supported.
InvalidDocument:
The specified document does not exist.
InvalidDocumentOperation:
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

UpdateDocumentDefaultVersion

$result = $client->updateDocumentDefaultVersion([/* ... */]);
$promise = $client->updateDocumentDefaultVersionAsync([/* ... */]);

Set the default version of a document.

Parameter Syntax

$result = $client->updateDocumentDefaultVersion([
    'DocumentVersion' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

DocumentVersion

Required: Yes
Type: string

The version of a custom document that you want to set as the default version.

Name

Required: Yes
Type: string

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

Result Syntax

[
    'Description' => [
        'DefaultVersion' => '<string>',
        'DefaultVersionName' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Members

Description

Type: DocumentDefaultVersionDescription structure

The description of a custom document that you want to set as the default version.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidDocumentVersion:
The document version is not valid or does not exist.
InvalidDocumentSchemaVersion:
The version of the document schema is not supported.

UpdateDocumentMetadata

$result = $client->updateDocumentMetadata([/* ... */]);
$promise = $client->updateDocumentMetadataAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateDocumentMetadata([
    'DocumentReviews' => [ // REQUIRED
        'Action' => 'SendForReview|UpdateReview|Approve|Reject', // REQUIRED
        'Comment' => [
            [
                'Content' => '<string>',
                'Type' => 'Comment',
            ],
            // ...
        ],
    ],
    'DocumentVersion' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

DocumentReviews

Required: Yes
Type: DocumentReviews structure

The document review details to update.

DocumentVersion

Type: string

The version of a document to update.

Name

Required: Yes
Type: string

The name of the document for which a version is to be updated.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
An error occurred on the server side.
InvalidDocument:
The specified document does not exist.
InvalidDocumentOperation:
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
InvalidDocumentVersion:
The document version is not valid or does not exist.

UpdateMaintenanceWindow

$result = $client->updateMaintenanceWindow([/* ... */]);
$promise = $client->updateMaintenanceWindowAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateMaintenanceWindow([
    'AllowUnassociatedTargets' => true || false,
    'Cutoff' => <integer>,
    'Description' => '<string>',
    'Duration' => <integer>,
    'Enabled' => true || false,
    'EndDate' => '<string>',
    'Name' => '<string>',
    'Replace' => true || false,
    'Schedule' => '<string>',
    'ScheduleOffset' => <integer>,
    'ScheduleTimezone' => '<string>',
    'StartDate' => '<string>',
    'WindowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AllowUnassociatedTargets

Type: boolean

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

Cutoff

Type: int

The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

Description

Type: string

An optional description for the update request.

Duration

Type: int

The duration of the maintenance window in hours.

Enabled

Type: boolean

Whether the maintenance window is enabled.

EndDate

Type: string

Name

Type: string

The name of the maintenance window.

Replace

Type: boolean

If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

Schedule

Type: string

The schedule of the maintenance window in the form of a cron or rate expression.

ScheduleOffset

Type: int

The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.

cron(30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

ScheduleTimezone

Type: string

StartDate

Type: string

WindowId

Required: Yes
Type: string

The ID of the maintenance window to update.

Result Syntax

[
    'AllowUnassociatedTargets' => true || false,
    'Cutoff' => <integer>,
    'Description' => '<string>',
    'Duration' => <integer>,
    'Enabled' => true || false,
    'EndDate' => '<string>',
    'Name' => '<string>',
    'Schedule' => '<string>',
    'ScheduleOffset' => <integer>,
    'ScheduleTimezone' => '<string>',
    'StartDate' => '<string>',
    'WindowId' => '<string>',
]

Result Details

Members

AllowUnassociatedTargets

Type: boolean

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

Cutoff

Type: int

The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

Description

Type: string

An optional description of the update.

Duration

Type: int

The duration of the maintenance window in hours.

Enabled

Type: boolean

Whether the maintenance window is enabled.

EndDate

Type: string

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.

Name

Type: string

The name of the maintenance window.

Schedule

Type: string

The schedule of the maintenance window in the form of a cron or rate expression.

ScheduleOffset

Type: int

The number of days to wait to run a maintenance window after the scheduled CRON expression date and time.

ScheduleTimezone

Type: string

StartDate

Type: string

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.

WindowId

Type: string

The ID of the created maintenance window.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

UpdateMaintenanceWindowTarget

$result = $client->updateMaintenanceWindowTarget([/* ... */]);
$promise = $client->updateMaintenanceWindowTargetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateMaintenanceWindowTarget([
    'Description' => '<string>',
    'Name' => '<string>',
    'OwnerInformation' => '<string>',
    'Replace' => true || false,
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'WindowId' => '<string>', // REQUIRED
    'WindowTargetId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Description

Type: string

An optional description for the update.

Name

Type: string

A name for the update.

OwnerInformation

Type: string

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

Replace

Type: boolean

If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

Targets

Type: Array of Target structures

The targets to add or replace.

WindowId

Required: Yes
Type: string

The maintenance window ID with which to modify the target.

WindowTargetId

Required: Yes
Type: string

The target ID to modify.

Result Syntax

[
    'Description' => '<string>',
    'Name' => '<string>',
    'OwnerInformation' => '<string>',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'WindowId' => '<string>',
    'WindowTargetId' => '<string>',
]

Result Details

Members

Description

Type: string

The updated description.

Name

Type: string

The updated name.

OwnerInformation

Type: string

The updated owner.

Targets

Type: Array of Target structures

The updated targets.

WindowId

Type: string

The maintenance window ID specified in the update request.

WindowTargetId

Type: string

The target ID specified in the update request.

Errors

DoesNotExistException:
Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerError:
An error occurred on the server side.

UpdateMaintenanceWindowTask

$result = $client->updateMaintenanceWindowTask([/* ... */]);
$promise = $client->updateMaintenanceWindowTaskAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->updateMaintenanceWindowTask([
    'Description' => '<string>',
    'LoggingInfo' => [
        'S3BucketName' => '<string>', // REQUIRED
        'S3KeyPrefix' => '<string>',
        'S3Region' => '<string>', // REQUIRED
    ],
    'MaxConcurrency' => '<string>',
    'MaxErrors' => '<string>',
    'Name' => '<string>',
    'Priority' => <integer>,
    'Replace' => true || false,
    'ServiceRoleArn' => '<string>',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'TaskArn' => '<string>',
    'TaskInvocationParameters' => [
        'Automation' => [
            'DocumentVersion' => '<string>',
            'Parameters' => [
                '<AutomationParameterKey>' => ['<string>', ...],
                // ...
            ],
        ],
        'Lambda' => [
            'ClientContext' => '<string>',
            'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
            'Qualifier' => '<string>',
        ],
        'RunCommand' => [
            'CloudWatchOutputConfig' => [
                'CloudWatchLogGroupName' => '<string>',
                'CloudWatchOutputEnabled' => true || false,
            ],
            'Comment' => '<string>',
            'DocumentHash' => '<string>',
            'DocumentHashType' => 'Sha256|Sha1',
            'DocumentVersion' => '<string>',
            'NotificationConfig' => [
                'NotificationArn' => '<string>',
                'NotificationEvents' => ['<string>', ...],
                'NotificationType' => 'Command|Invocation',
            ],
            'OutputS3BucketName' => '<string>',
            'OutputS3KeyPrefix' => '<string>',
            'Parameters' => [
                '<ParameterName>' => ['<string>', ...],
                // ...
            ],
            'ServiceRoleArn' => '<string>',
            'TimeoutSeconds' => <integer>,
        ],
        'StepFunctions' => [
            'Input' => '<string>',
            'Name' => '<string>',
        ],
    ],
    'TaskParameters' => [
        '<MaintenanceWindowTaskParameterName>' => [
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'WindowId' => '<string>', // REQUIRED
    'WindowTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Description

Type: string

The new task description to specify.

LoggingInfo

Type: LoggingInfo structure

The new logging location in Amazon S3 to specify.

MaxConcurrency

Type: string

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

MaxErrors

Type: string

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Name

Type: string

The new task name to specify.

Priority

Type: int

The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Replace

Type: boolean

If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

ServiceRoleArn

Type: string

For more information, see the following topics in the in the AWS Systems Manager User Guide:

Targets

Type: Array of Target structures

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

TaskArn

Type: string

The task ARN to modify.

TaskInvocationParameters

Type: MaintenanceWindowTaskInvocationParameters structure

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

TaskParameters

Type: Associative array of custom strings keys (MaintenanceWindowTaskParameterName) to MaintenanceWindowTaskParameterValueExpression structures

The parameters to modify.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

WindowId

Required: Yes
Type: string

The maintenance window ID that contains the task to modify.

WindowTaskId

Required: Yes
Type: string

The task ID to modify.

Result Syntax

[
    'Description' => '<string>',
    'LoggingInfo' => [
        'S3BucketName' => '<string>',
        'S3KeyPrefix' => '<string>',
        'S3Region' => '<string>',
    ],
    'MaxConcurrency' => '<string>',
    'MaxErrors' => '<string>',
    'Name' => '<string>',
    'Priority' => <integer>,
    'ServiceRoleArn' => '<string>',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'TaskArn' => '<string>',
    'TaskInvocationParameters' => [
        'Automation' => [
            'DocumentVersion' => '<string>',
            'Parameters' => [
                '<AutomationParameterKey>' => ['<string>', ...],
                // ...
            ],
        ],
        'Lambda' => [
            'ClientContext' => '<string>',
            'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
            'Qualifier' => '<string>',
        ],
        'RunCommand' => [
            'CloudWatchOutputConfig' => [
                'CloudWatchLogGroupName' => '<string>',
                'CloudWatchOutputEnabled' => true || false,
            ],
            'Comment' => '<string>',
            'DocumentHash' => '<string>',
            'DocumentHashType' => 'Sha256|Sha1',
            'DocumentVersion' => '<string>',
            'NotificationConfig' => [
                'NotificationArn' => '<string>',
                'NotificationEvents' => ['<string>', ...],
                'NotificationType' => 'Command|Invocation',
            ],
            'OutputS3BucketName' => '<string>',
            'OutputS3KeyPrefix' => '<string>',
            'Parameters' => [
                '<ParameterName>' => ['<string>', ...],
                // ...
            ],
            'ServiceRoleArn' => '<string>',
            'TimeoutSeconds' => <integer>,
        ],
        'StepFunctions' => [
            'Input' => '<string>',
            'Name' => '<string>',
        ],
    ],
    'TaskParameters' => [
        '<MaintenanceWindowTaskParameterName>' => [
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'WindowId' => '<string>',
    'WindowTaskId' => '<string>',
]

Result Details

Members

Description

Type: string

The updated task description.

LoggingInfo

Type: LoggingInfo structure

The updated logging information in Amazon S3.

MaxConcurrency

Type: string

The updated MaxConcurrency value.

MaxErrors

Type: string

The updated MaxErrors value.

Name

Type: string

The updated task name.

Priority

Type: int

The updated priority value.

ServiceRoleArn

Type: string

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

Targets

Type: Array of Target structures

The updated target values.

TaskArn

Type

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Simple Systems Manager (SSM) 2014-11-06

Operation Summary

Paginators

Waiters

Operations

AddTagsToResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CancelCommand

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CancelMaintenanceWindowExecution

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateActivation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAssociation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAssociationBatch

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDocument

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMaintenanceWindow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateOpsItem

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members