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 = [] )
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command.
CreateAssociation ( array $params = [] )
Associates the specified Systems Manager document with the specified instances or targets.
CreateAssociationBatch ( array $params = [] )
Associates the specified Systems Manager document with the specified instances or targets.
CreateDocument ( array $params = [] )
Creates a Systems Manager document.
CreateMaintenanceWindow ( array $params = [] )
Creates a new Maintenance Window.
CreatePatchBaseline ( array $params = [] )
Creates a patch baseline.
CreateResourceDataSync ( array $params = [] )
Creates a resource data sync configuration to a single bucket in Amazon S3.
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.
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 = [] )
Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
DescribeAssociation ( 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 that could possibly 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.
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 Windows targets or tasks that an instance is associated with.
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.
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 connected 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 task run as part of 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 a task invocation.
GetMaintenanceWindowTask ( array $params = [] )
Lists the tasks in a Maintenance Window.
GetParameter ( array $params = [] )
Get information about a parameter by using the parameter name.
GetParameterHistory ( array $params = [] )
Query a list of all parameters used by the AWS account.
GetParameters ( array $params = [] )
Get details of a parameter.
GetParametersByPath ( array $params = [] )
Retrieve 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 = [] )
Lists the associations for the specified Systems Manager document or instance.
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.
ListDocumentVersions ( array $params = [] )
List all versions for a document.
ListDocuments ( array $params = [] )
Describes one or more of your Systems Manager documents.
ListInventoryEntries ( array $params = [] )
A list of inventory items returned by the request.
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.
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 all tags 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.
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.
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 = [] )
The document you want to update.
UpdateDocumentDefaultVersion ( array $params = [] )
Set the default 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 = [] )
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
UpdatePatchBaseline ( array $params = [] )
Modifies an existing patch baseline.
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
DescribeInstanceInformation
DescribeParameters
GetParameterHistory
GetParametersByPath
ListAssociations
ListCommandInvocations
ListCommands
ListDocuments

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 Amazon EC2 and are interpreted strictly as a string of characters.

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

Parameter Syntax

$result = $client->addTagsToResource([
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => 'Document|ManagedInstance|MaintenanceWindow|Parameter|PatchBaseline', // 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

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 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 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, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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 limits in Systems Manager, see AWS Systems Manager Limits.

CreateActivation

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

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.

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 Amazon EC2 console or when you use the AWS command line tools to list EC2 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 Amazon EC2.

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. The default value is 24 hours.

IamRole

Required: Yes
Type: string

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.

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([/* ... */]);

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->createAssociation([
    '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>',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members

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.

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

Targets

Type: Array of Target structures

The targets (either instances or tags) for the association.

Result Syntax

[
    'AssociationDescription' => [
        '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',
        ],
        '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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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 EC2 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
        [
            '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>',
            'Targets' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

Entries

Required: Yes
Type: Array of CreateAssociationBatchRequestEntry structures

One or more associations.

Result Syntax

[
    'Failed' => [
        [
            'Entry' => [
                '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>',
                'Targets' => [
                    [
                        'Key' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'Fault' => 'Client|Server|Unknown',
            'Message' => '<string>',
        ],
        // ...
    ],
    'Successful' => [
        [
            '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',
            ],
            '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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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

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

Parameter Syntax

$result = $client->createDocument([
    'Attachments' => [
        [
            'Key' => 'SourceUrl',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'Content' => '<string>', // REQUIRED
    'DocumentFormat' => 'YAML|JSON',
    'DocumentType' => 'Command|Policy|Automation|Session|Package',
    'Name' => '<string>', // REQUIRED
    '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

A valid JSON or YAML string.

DocumentFormat

Type: string

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

DocumentType

Type: string

The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package.

Name

Required: Yes
Type: string

A name for the Systems Manager document.

Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes:

aws
amazon
amzn

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 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' => [
        'AttachmentsInformation' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'CreatedDate' => <DateTime>,
        'DefaultVersion' => '<string>',
        'Description' => '<string>',
        'DocumentFormat' => 'YAML|JSON',
        'DocumentType' => 'Command|Policy|Automation|Session|Package',
        'DocumentVersion' => '<string>',
        'Hash' => '<string>',
        'HashType' => 'Sha256|Sha1',
        'LatestVersion' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'Parameters' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'Name' => '<string>',
                'Type' => 'String|StringList',
            ],
            // ...
        ],
        'PlatformTypes' => ['<string>', ...],
        '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 200 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.

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

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", "etc/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 limits. For example, too many Maintenance Windows or Patch baselines have been created.

For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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>, // REQUIRED
                'ComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
                'EnableNonSecurity' => true || false,
                'PatchFilterGroup' => [ // REQUIRED
                    'PatchFilters' => [ // REQUIRED
                        [
                            'Key' => 'PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|MSRC_SEVERITY|PATCH_ID|SECTION|PRIORITY|SEVERITY', // REQUIRED
                            'Values' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
    ],
    'ApprovedPatches' => ['<string>', ...],
    'ApprovedPatchesComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
    'ApprovedPatchesEnableNonSecurity' => true || false,
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'GlobalFilters' => [
        'PatchFilters' => [ // REQUIRED
            [
                'Key' => 'PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|MSRC_SEVERITY|PATCH_ID|SECTION|PRIORITY|SEVERITY', // REQUIRED
                'Values' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS',
    '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 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. This means that if an approved patch is reported as missing, this is 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.

For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.

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 limits. For example, too many Maintenance Windows or Patch baselines have been created.

For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerError:
An error occurred on the server side.

CreateResourceDataSync

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

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

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. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.

Parameter Syntax

$result = $client->createResourceDataSync([
    'S3Destination' => [ // REQUIRED
        'AWSKMSKeyARN' => '<string>',
        'BucketName' => '<string>', // REQUIRED
        'Prefix' => '<string>',
        'Region' => '<string>', // REQUIRED
        'SyncFormat' => 'JsonSerDe', // REQUIRED
    ],
    'SyncName' => '<string>', // REQUIRED
]);

Parameter Details

Members

S3Destination

Required: Yes
Type: ResourceDataSyncS3Destination structure

Amazon S3 configuration details for the sync.

SyncName

Required: Yes
Type: string

A name for the configuration.

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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the document.

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 disbled 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 Understanding the Delete Inventory Summary 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.

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

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

Parameter Syntax

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

Parameter Details

Members

SyncName

Required: Yes
Type: string

The name of the configuration 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.

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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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 limits in Systems Manager, see AWS Systems Manager Limits.
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 limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerError:
An error occurred on the server side.

DescribeActivations

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

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

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' => [
        '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',
        ],
        '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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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', // 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' => [
        [
            'AutomationExecutionId' => '<string>',
            'AutomationExecutionStatus' => 'Pending|InProgress|Waiting|Success|TimedOut|Cancelling|Cancelled|Failed',
            'AutomationType' => 'CrossAccount|Local',
            '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',
            'Outputs' => [
                '<AutomationParameterKey>' => ['<string>', ...],
                // ...
            ],
            'ParentAutomationExecutionId' => '<string>',
            'ResolvedTargets' => [
                'ParameterValues' => ['<string>', ...],
                'Truncated' => true || false,
            ],
            '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',
            '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 that could possibly 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' => [
        [
            'Classification' => '<string>',
            'ContentUrl' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'KbNumber' => '<string>',
            'Language' => '<string>',
            'MsrcNumber' => '<string>',
            'MsrcSeverity' => '<string>',
            'Product' => '<string>',
            'ProductFamily' => '<string>',
            'ReleaseDate' => <DateTime>,
            'Title' => '<string>',
            'Vendor' => '<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' => [
        'AttachmentsInformation' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'CreatedDate' => <DateTime>,
        'DefaultVersion' => '<string>',
        'Description' => '<string>',
        'DocumentFormat' => 'YAML|JSON',
        'DocumentType' => 'Command|Policy|Automation|Session|Package',
        'DocumentVersion' => '<string>',
        'Hash' => '<string>',
        'HashType' => 'Sha256|Sha1',
        'LatestVersion' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'Parameters' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'Name' => '<string>',
                'Type' => 'String|StringList',
            ],
            // ...
        ],
        'PlatformTypes' => ['<string>', ...],
        '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([
    'Name' => '<string>', // REQUIRED
    'PermissionType' => 'Share', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

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

PermissionType

Required: Yes
Type: string

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

Result Syntax

[
    'AccountIds' => ['<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.

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.

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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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' => [
                'Classification' => '<string>',
                'ContentUrl' => '<string>',
                'Description' => '<string>',
                'Id' => '<string>',
                'KbNumber' => '<string>',
                'Language' => '<string>',
                'MsrcNumber' => '<string>',
                'MsrcSeverity' => '<string>',
                'Product' => '<string>',
                'ProductFamily' => '<string>',
                'ReleaseDate' => <DateTime>,
                'Title' => '<string>',
                'Vendor' => '<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 limits in Systems Manager, see AWS Systems Manager Limits.
UnsupportedOperatingSystem:
The operating systems you specified is not supported, or the operation is not supported for the operating system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.
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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

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 Amazon 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 on Amazon EC2 tag. Specify tags by using a key-value mapping.

InstanceInformationFilterList

Type: Array of InstanceInformationFilter structures

This is a legacy method. We recommend that you don't use this method. Instead, use the InstanceInformationFilter action. The InstanceInformationFilter action enables you to return instance information by using tags that are specified as a key-value mapping.

If you do use this method, then you can't use the InstanceInformationFilter action. Using this method and the InstanceInformationFilter action causes 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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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>',
            'FailedCount' => <integer>,
            'InstallOverrideList' => '<string>',
            'InstalledCount' => <integer>,
            'InstalledOtherCount' => <integer>,
            'InstalledRejectedCount' => <integer>,
            'InstanceId' => '<string>',
            'MissingCount' => <integer>,
            'NotApplicableCount' => <integer>,
            'Operation' => 'Scan|Install',
            'OperationEndTime' => <DateTime>,
            'OperationStartTime' => <DateTime>,
            'OwnerInformation' => '<string>',
            'PatchGroup' => '<string>',
            '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>',
            'FailedCount' => <integer>,
            'InstallOverrideList' => '<string>',
            'InstalledCount' => <integer>,
            'InstalledOtherCount' => <integer>,
            'InstalledRejectedCount' => <integer>,
            'InstanceId' => '<string>',
            'MissingCount' => <integer>,
            'NotApplicableCount' => <integer>,
            'Operation' => 'Scan|Install',
            'OperationEndTime' => <DateTime>,
            'OperationStartTime' => <DateTime>,
            'OwnerInformation' => '<string>',
            'PatchGroup' => '<string>',
            '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

Each entry in the array is a structure containing:

Key (string, between 1 and 128 characters)

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

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' => [
        [
            'Classification' => '<string>',
            'InstalledTime' => <DateTime>,
            'KBId' => '<string>',
            'Severity' => '<string>',
            'State' => 'INSTALLED|INSTALLED_OTHER|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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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 valide. 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 limits in Systems Manager, see AWS Systems Manager Limits.
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 limits in Systems Manager, see AWS Systems Manager Limits.
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 Windows execution.

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',
    '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 limits in Systems Manager, see AWS Systems Manager Limits.

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',
            '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 limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerError:
An error occurred on the server side.

DescribeMaintenanceWindowTasks

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

Lists the tasks in a Maintenance Window.

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 limits in Systems Manager, see AWS Systems Manager Limits.
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>',
            '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 Windows targets or tasks that an instance is associated with.

Parameter Syntax

$result = $client->describeMaintenanceWindowsForTarget([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => 'INSTANCE', // 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.

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

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

ParameterFilters

Type: Array of ParameterStringFilter structures

Filters to limit the request results.

Result Syntax

[
    'NextToken' => '<string>',
    'Parameters' => [
        [
            'AllowedPattern' => '<string>',
            'Description' => '<string>',
            'KeyId' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'LastModifiedUser' => '<string>',
            'Name' => '<string>',
            'Policies' => [
                [
                    'PolicyStatus' => '<string>',
                    'PolicyText' => '<string>',
                    'PolicyType' => '<string>',
                ],
                // ...
            ],
            'Tier' => 'Standard|Advanced',
            'Type' => 'String|StringList|SecureString',
            '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 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',
        ],
        // ...
    ],
    '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>,
    'InstancesWithFailedPatches' => <integer>,
    'InstancesWithInstalledOtherPatches' => <integer>,
    'InstancesWithInstalledPatches' => <integer>,
    'InstancesWithInstalledRejectedPatches' => <integer>,
    'InstancesWithMissingPatches' => <integer>,
    'InstancesWithNotApplicablePatches' => <integer>,
    'InstancesWithUnreportedNotApplicablePatches' => <integer>,
]

Result Details

Members

Instances

Type: int

The number of instances in the patch group.

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.

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.

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.

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',
            ],
            '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:

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

Parameter Syntax

$result = $client->describePatchProperties([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS', // 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 Linux 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', // 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' => [
        'AutomationExecutionId' => '<string>',
        'AutomationExecutionStatus' => 'Pending|InProgress|Waiting|Success|TimedOut|Cancelling|Cancelled|Failed',
        'CurrentAction' => '<string>',
        'CurrentStepName' => '<string>',
        'DocumentName' => '<string>',
        'DocumentVersion' => '<string>',
        'ExecutedBy' => '<string>',
        'ExecutionEndTime' => <DateTime>,
        'ExecutionStartTime' => <DateTime>,
        'FailureMessage' => '<string>',
        'MaxConcurrency' => '<string>',
        'MaxErrors' => '<string>',
        'Mode' => 'Auto|Interactive',
        '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,
        ],
        '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',
                '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.

GetCommandInvocation

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

Returns detailed information about command execution for an invocation or plugin.

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 EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

PluginName

Type: string

(Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned.

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 was 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 Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

PluginName

Type: string

The name of the plugin for which you want detailed results. 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 S3. If an Amazon 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, the instance was stopped, etc. The system will try to deliver the command again.
Success: The command or plugin was run 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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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 adn 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 connected 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',
]);

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',
]

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([
    'InstanceId' => '<string>', // REQUIRED
    'SnapshotId' => '<string>', // REQUIRED
]);

Parameter Details

Members

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. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.
UnsupportedFeatureRequiredException:

GetDocument

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

Gets the contents of the specified Systems Manager document.

Parameter Syntax

$result = $client->getDocument([
    'DocumentFormat' => 'YAML|JSON',
    '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',
    'DocumentType' => 'Command|Policy|Automation|Session|Package',
    'DocumentVersion' => '<string>',
    'Name' => '<string>',
    '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, etc.

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.

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 desired Maintenance Window.

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

Whether the Maintenance Windows 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.

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 limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerError:
An error occurred on the server side.

GetMaintenanceWindowExecution

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

Retrieves details about a specific task run as part of 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 limits in Systems Manager, see AWS Systems Manager Limits.
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 limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerError:
An error occurred on the server side.

GetMaintenanceWindowExecutionTaskInvocation

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

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

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_FUNCTION, 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 limits in Systems Manager, see AWS Systems Manager Limits.
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' => [
            'Comment' => '<string>',
            'DocumentHash' => '<string>',
            'DocumentHashType' => 'Sha256|Sha1',
            '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.

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 IAM service role to assume during task execution.

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_FUNCTION 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 limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerError:
An error occurred on the server side.

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>',
        '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([/* ... */]);

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

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 a parameter you want to query.

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>',
            'Description' => '<string>',
            'KeyId' => '<string>',
            'Labels' => ['<string>', ...],
            'LastModifiedDate' => <DateTime>,
            'LastModifiedUser' => '<string>',
            'Name' => '<string>',
            'Policies' => [
                [
                    'PolicyStatus' => '<string>',
                    'PolicyText' => '<string>',
                    'PolicyType' => '<string>',
                ],
                // ...
            ],
            'Tier' => 'Standard|Advanced',
            '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>',
            '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 when executed.

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

This API action doesn't support filtering by tags.

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.

You can't filter using the parameter name.

Path

Required: Yes
Type: string

The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. 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>',
            '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>,
                'ComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
                'EnableNonSecurity' => true || false,
                'PatchFilterGroup' => [
                    'PatchFilters' => [
                        [
                            'Key' => 'PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|MSRC_SEVERITY|PATCH_ID|SECTION|PRIORITY|SEVERITY',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
    ],
    'ApprovedPatches' => ['<string>', ...],
    'ApprovedPatchesComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
    'ApprovedPatchesEnableNonSecurity' => true || false,
    'BaselineId' => '<string>',
    'CreatedDate' => <DateTime>,
    'Description' => '<string>',
    'GlobalFilters' => [
        'PatchFilters' => [
            [
                'Key' => 'PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|MSRC_SEVERITY|PATCH_ID|SECTION|PRIORITY|SEVERITY',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'ModifiedDate' => <DateTime>,
    'Name' => '<string>',
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS',
    '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 limits in Systems Manager, see AWS Systems Manager Limits.
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',
    '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',
    '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.

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.
You can't delete a parameter label. If you no longer want to use a parameter label, then you must 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>', ...],
]

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.

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' => [
        [
            '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>',
            '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([/* ... */]);

Lists the associations for the specified Systems Manager document or instance.

Parameter Syntax

$result = $client->listAssociations([
    'AssociationFilterList' => [
        [
            'key' => 'InstanceId|Name|AssociationId|AssociationStatusName|LastExecutedBefore|LastExecutedAfter|AssociationName', // 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.

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. By default this is set to 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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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.

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>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    '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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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.

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 about which you want version information.

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',
            'DocumentVersion' => '<string>',
            'IsDefaultVersion' => true || false,
            'Name' => '<string>',
            '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([/* ... */]);

Describes one or more of your Systems Manager documents.

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

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

Filters

Type: Array of DocumentKeyValuesFilter 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.)

Result Syntax

[
    'DocumentIdentifiers' => [
        [
            'DocumentFormat' => 'YAML|JSON',
            'DocumentType' => 'Command|Policy|Automation|Session|Package',
            'DocumentVersion' => '<string>',
            'Name' => '<string>',
            'Owner' => '<string>',
            'PlatformTypes' => ['<string>', ...],
            '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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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.

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>',
]);

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.

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceDataSyncItems' => [
        [
            'LastStatus' => 'Successful|Failed|InProgress',
            'LastSuccessfulSyncTime' => <DateTime>,
            'LastSyncStatusMessage' => '<string>',
            'LastSyncTime' => <DateTime>,
            'S3Destination' => [
                'AWSKMSKeyARN' => '<string>',
                'BucketName' => '<string>',
                'Prefix' => '<string>',
                'Region' => '<string>',
                'SyncFormat' => 'JsonSerDe',
            ],
            'SyncCreatedTime' => <DateTime>,
            'SyncName' => '<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

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', // 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
]);

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.

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

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

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.

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

One or more instance IDs 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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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>',
    'Description' => '<string>',
    'KeyId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Overwrite' => true || false,
    'Policies' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tier' => 'Standard|Advanced',
    'Type' => 'String|StringList|SecureString', // REQUIRED
    '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+$

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 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_.-/
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 Requirements and Constraints for Parameter Names 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 the fully qualified parameter name is 1011 characters.

Overwrite

Type: boolean

Overwrite an existing parameter. If not specified, will default to "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 Working with 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

Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.

Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.

If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at 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. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.

Type

Required: Yes
Type: string

The type of parameter that you want to add to the system.

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.

SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.

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.

Result Syntax

[
    'Version' => <integer>,
]

Result Details

Members

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:
The parameter exceeded the maximum number of allowed versions.
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.

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 limits in Systems Manager, see AWS Systems Manager Limits.
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 limits in Systems Manager, see AWS Systems Manager Limits.
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 limits. For example, too many Maintenance Windows or Patch baselines have been created.

For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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', // 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 (either instances or tags).

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify tags using either of the following formats:

Key=tag:<tag-key>,Values=<tag-value-1>,<tag-value-2>

Key=tag-key,Values=<tag-key-1>,<tag-key-2>

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 limits in Systems Manager, see AWS Systems Manager Limits.
ResourceLimitExceededException:
Error returned when the caller has exceeded the default resource limits. For example, too many Maintenance Windows or Patch baselines have been created.

For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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>', // REQUIRED
    'MaxErrors' => '<string>', // REQUIRED
    'Name' => '<string>',
    'Priority' => <integer>,
    'ServiceRoleArn' => '<string>',
    'Targets' => [ // REQUIRED
        [
            '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' => [
            'Comment' => '<string>',
            'DocumentHash' => '<string>',
            'DocumentHashType' => 'Sha256|Sha1',
            '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 Amazon S3 bucket to write instance-level logs to.

MaxConcurrency

Required: Yes
Type: string

The maximum number of targets this task can be run for in parallel.

MaxErrors

Required: Yes
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 role to assume when running the Maintenance Window task.

If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN.

For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide.

Targets

Required: Yes
Type: Array of Target structures

The targets (either instances or Maintenance Window targets).

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 limits in Systems Manager, see AWS Systems Manager Limits.
ResourceLimitExceededException:
Error returned when the caller has exceeded the default resource limits. For example, too many Maintenance Windows or Patch baselines have been created.

For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
FeatureNotAvailableException:
You attempted to register a LAMBDA or STEP_FUNCTION 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 all tags from the specified resource.

Parameter Syntax

$result = $client->removeTagsFromResource([
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => 'Document|ManagedInstance|MaintenanceWindow|Parameter|PatchBaseline', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceId

Required: Yes
Type: string

The resource ID for which you want to remove tags. Use the ID of the resource. Here are some examples:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

PatchBaseline: pb-012345abcde

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

ResourceType

Required: Yes
Type: string

The type of resource of which you want to remove a tag.

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 ID of the service setting to reset.

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://ssm-messages.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 the AWS Systems Manager table of regions and 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 limits in Systems Manager, see AWS Systems Manager Limits.
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.

SignalType

Required: Yes
Type: string

The type of signal. Valid signal types include the following: Approve and Reject

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

Required. The name of the Systems Manager document to run. This can be a public document or a custom document.

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 instance IDs where the command should run. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use targets, see Sending 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 Amazon S3 bucket region.

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 IAM role that Systems Manager uses to send notifications.

Targets

Type: Array of Target structures

(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. 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>', ...],
            ],
            // ...
        ],
    ],
]

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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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>', ...],
        // ...
    ],
    '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

The name of the Automation document to use for this execution.

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.

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 Executing Automations 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 EC2 Systems Manager or you might not have permission to perform the operation.
InternalServerError:
An error occurred on the server side.

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.

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. 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.
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 limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerError:
An error occurred on the server side.

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.

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

Parameter Syntax

$result = $client->updateAssociation([
    '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>',
    'Targets' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members

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

Targets

Type: Array of Target structures

The targets of the association.

Result Syntax

[
    'AssociationDescription' => [
        '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',
        ],
        '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 EC2 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' => [
        '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',
        ],
        '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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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([/* ... */]);

The document you want to update.

Parameter Syntax

$result = $client->updateDocument([
    'Attachments' => [
        [
            'Key' => 'SourceUrl',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'Content' => '<string>', // REQUIRED
    'DocumentFormat' => 'YAML|JSON',
    '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.

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' => [
        'AttachmentsInformation' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'CreatedDate' => <DateTime>,
        'DefaultVersion' => '<string>',
        'Description' => '<string>',
        'DocumentFormat' => 'YAML|JSON',
        'DocumentType' => 'Command|Policy|Automation|Session|Package',
        'DocumentVersion' => '<string>',
        'Hash' => '<string>',
        'HashType' => 'Sha256|Sha1',
        'LatestVersion' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'Parameters' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'Name' => '<string>',
                'Type' => 'String|StringList',
            ],
            // ...
        ],
        'PlatformTypes' => ['<string>', ...],
        '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.

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

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

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 limits in Systems Manager, see AWS Systems Manager Limits.
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't change the target type, but you can change the following:

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

IDs for an ID target.

Tags for a Tag target.

Owner.

Name.

Description.

If a parameter is null, then the corresponding field is not modified.

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 limits in Systems Manager, see AWS Systems Manager Limits.
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 a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.

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' => [
            'Comment' => '<string>',
            'DocumentHash' => '<string>',
            'DocumentHashType' => 'Sha256|Sha1',
            '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 RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.

ServiceRoleArn

Type: string

The IAM service role ARN to modify. The system assumes this role during task execution.

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' => [
            'Comment' => '<string>',
            'DocumentHash' => '<string>',
            'DocumentHashType' => 'Sha256|Sha1',
            '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 updated service role ARN value.

Targets

Type: Array of Target structures

The updated target values.

TaskArn

Type: string

The updated task ARN value.

TaskInvocationParameters

Type: MaintenanceWindowTaskInvocationParameters structure

The updated parameter values.

TaskParameters

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

The updated parameter values.

WindowId

Type: string

The ID of the Maintenance Window that was updated.

WindowTaskId

Type: string

The task ID of the Maintenance Window that was updated.

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 limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerError:
An error occurred on the server side.

UpdateManagedInstanceRole

$result = $client->updateManagedInstanceRole([/* ... */]);
$promise = $client->updateManagedInstanceRoleAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Members

IamRole

Required: Yes
Type: string

The IAM role you want to assign or change.

InstanceId

Required: Yes
Type: string

The ID of the managed instance where you want to update the role.

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. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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.

UpdatePatchBaseline

$result = $client->updatePatchBaseline([/* ... */]);
$promise = $client->updatePatchBaselineAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->updatePatchBaseline([
    'ApprovalRules' => [
        'PatchRules' => [ // REQUIRED
            [
                'ApproveAfterDays' => <integer>, // REQUIRED
                'ComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
                'EnableNonSecurity' => true || false,
                'PatchFilterGroup' => [ // REQUIRED
                    'PatchFilters' => [ // REQUIRED
                        [
                            'Key' => 'PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|MSRC_SEVERITY|PATCH_ID|SECTION|PRIORITY|SEVERITY', // REQUIRED
                            'Values' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
    ],
    'ApprovedPatches' => ['<string>', ...],
    'ApprovedPatchesComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
    'ApprovedPatchesEnableNonSecurity' => true || false,
    'BaselineId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'GlobalFilters' => [
        'PatchFilters' => [ // REQUIRED
            [
                'Key' => 'PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|MSRC_SEVERITY|PATCH_ID|SECTION|PRIORITY|SEVERITY', // REQUIRED
                'Values' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'RejectedPatches' => ['<string>', ...],
    'RejectedPatchesAction' => 'ALLOW_AS_DEPENDENCY|BLOCK',
    'Replace' => true || false,
    'Sources' => [
        [
            'Configuration' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
            'Products' => ['<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 Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.

ApprovedPatchesComplianceLevel

Type: string

Assigns a new compliance severity level to an existing 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

Required: Yes
Type: string

The ID of the patch baseline to update.

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

Type: string

The name of the patch baseline.

RejectedPatches

Type: Array of strings

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.

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.

Replace

Type: boolean

If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null.

Sources

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.

Result Syntax

[
    'ApprovalRules' => [
        'PatchRules' => [
            [
                'ApproveAfterDays' => <integer>,
                'ComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
                'EnableNonSecurity' => true || false,
                'PatchFilterGroup' => [
                    'PatchFilters' => [
                        [
                            'Key' => 'PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|MSRC_SEVERITY|PATCH_ID|SECTION|PRIORITY|SEVERITY',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
    ],
    'ApprovedPatches' => ['<string>', ...],
    'ApprovedPatchesComplianceLevel' => 'CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL|UNSPECIFIED',
    'ApprovedPatchesEnableNonSecurity' => true || false,
    'BaselineId' => '<string>',
    'CreatedDate' => <DateTime>,
    'Description' => '<string>',
    'GlobalFilters' => [
        'PatchFilters' => [
            [
                'Key' => 'PATCH_SET|PRODUCT|PRODUCT_FAMILY|CLASSIFICATION|MSRC_SEVERITY|PATCH_ID|SECTION|PRIORITY|SEVERITY',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'ModifiedDate' => <DateTime>,
    'Name' => '<string>',
    'OperatingSystem' => 'WINDOWS|AMAZON_LINUX|AMAZON_LINUX_2|UBUNTU|REDHAT_ENTERPRISE_LINUX|SUSE|CENTOS',
    '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

The compliance severity level assigned to the patch baseline after the update completed.

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 deleted patch baseline.

CreatedDate

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

The date when 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 when the patch baseline was last modified.

Name

Type: string

The name of the patch baseline.

OperatingSystem

Type: string

The operating system rule used by the updated patch baseline.

RejectedPatches

Type: Array of strings

A list of explicitly rejected patches for the baseline.

RejectedPatchesAction

Type: string

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 limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerError:
An error occurred on the server side.

UpdateServiceSetting

$result = $client->updateServiceSetting([/* ... */]);
$promise = $client->updateServiceSettingAsync([/* ... */]);

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

Update the service setting for the account.

Parameter Syntax

$result = $client->updateServiceSetting([
    'SettingId' => '<string>', // REQUIRED
    'SettingValue' => '<string>', // REQUIRED
]);

Parameter Details

Members

SettingId

Required: Yes
Type: string

The ID of the service setting to update.

SettingValue

Required: Yes
Type: string

The new value to specify for the service setting.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

Shapes

Activation

Description

An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.

Members

ActivationId

Type: string

The ID created by Systems Manager when you submitted the activation.

CreatedDate

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

The date the activation was created.

DefaultInstanceName

Type: string

A name for the managed instance when it is created.

Description

Type: string

A user defined description of the activation.

ExpirationDate

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

The date when this activation can no longer be used to register managed instances.

Expired

Type: boolean

Whether or not the activation is expired.

IamRole

Type: string

The Amazon Identity and Access Management (IAM) role to assign to the managed instance.

RegistrationLimit

Type: int

The maximum number of managed instances that can be registered using this activation.

RegistrationsCount

Type: int

The number of managed instances already registered with this activation.

Tags

Type: Array of Tag structures

Tags assigned to the activation.

AlreadyExistsException

Description

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.

Members

Message

Type: string

AssociatedInstances

Description

You must disassociate a document from all instances before you can delete it.

Members

Association

Description

Describes an association of a Systems Manager document and an instance.

Members

AssociationId

Type: string

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

AssociationName

Type: string

The association name.

AssociationVersion

Type: string

The association version.

DocumentVersion

Type: string

The version of the document used in the association.

InstanceId

Type: string

The ID of the instance.

LastExecutionDate

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

The date on which the association was last run.

Name

Type: string

The name of the Systems Manager document.

Overview

Type: AssociationOverview structure

Information about the association.

ScheduleExpression

Type: string

A cron expression that specifies a schedule when the association runs.

Targets

Type: Array of Target structures

The instances targeted by the request to create an association.

AssociationAlreadyExists

Description

The specified association already exists.

Members

AssociationDescription

Description

Describes the parameters for a document.

Members

AssociationId

Type: string

The association ID.

AssociationName

Type: string

The association name.

AssociationVersion

Type: string

The association version.

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 that is assigned to the association.

Date

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

The date when the association was made.

DocumentVersion

Type: string

The document version.

InstanceId

Type: string

The ID of the instance.

LastExecutionDate

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

The date on which the association was last run.

LastSuccessfulExecutionDate

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

The last date on which the association was successfully run.

LastUpdateAssociationDate

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

The date when the association was last updated.

MaxConcurrency

Type: string

MaxErrors

Type: string

Name

Type: string

The name of the Systems Manager document.

OutputLocation

Type: InstanceAssociationOutputLocation structure

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

Overview

Type: AssociationOverview structure

Information about the association.

Parameters

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

A description of the parameters for a document.

ScheduleExpression

Type: string

A cron expression that specifies a schedule when the association runs.

Status

Type: AssociationStatus structure

The association status.

Targets

Type: Array of Target structures

The instances targeted by the request.

AssociationDoesNotExist

Description

The specified association does not exist.

Members

Message

Type: string

AssociationExecution

Description

Includes information about the specified association.

Members

AssociationId

Type: string

The association ID.

AssociationVersion

Type: string

The association version.

CreatedTime

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

The time the execution started.

DetailedStatus

Type: string

Detailed status information about the execution.

ExecutionId

Type: string

The execution ID for the association.

LastExecutionDate

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

The date of the last execution.

ResourceCountByStatus

Type: string

An aggregate status of the resources in the execution based on the status type.

Status

Type: string

The status of the association execution.

AssociationExecutionDoesNotExist

Description

The specified execution ID does not exist. Verify the ID number and try again.

Members

Message

Type: string

AssociationExecutionFilter

Description

Filters used in the request.

Members

Key

Required: Yes
Type: string

The key value used in the request.

Type

Required: Yes
Type: string

The filter type specified in the request.

Value

Required: Yes
Type: string

The value specified for the key.

AssociationExecutionTarget

Description

Includes information about the specified association execution.

Members

AssociationId

Type: string

The association ID.

AssociationVersion

Type: string

The association version.

DetailedStatus

Type: string

Detailed information about the execution status.

ExecutionId

Type: string

The execution ID.

LastExecutionDate

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

The date of the last execution.

OutputSource

Type: OutputSource structure

The location where the association details are saved.

ResourceId

Type: string

The resource ID, for example, the instance ID where the association ran.

ResourceType

Type: string

The resource type, for example, instance.

Status

Type: string

The association execution status.

AssociationExecutionTargetsFilter

Description

Filters for the association execution.

Members

Key

Required: Yes
Type: string

The key value used in the request.

Value

Required: Yes
Type: string

The value specified for the key.

AssociationFilter

Description

Describes a filter.

Members

key

Required: Yes
Type: string

The name of the filter.

value

Required: Yes
Type: string

The filter value.

AssociationLimitExceeded

Description

You can have at most 2,000 active associations.

Members

AssociationOverview

Description

Information about the association.

Members

AssociationStatusAggregatedCount

Type: Associative array of custom strings keys (StatusName) to ints

Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.

DetailedStatus

Type: string

A detailed status of the association.

Status

Type: string

The status of the association. Status can be: Pending, Success, or Failed.

AssociationStatus

Description

Describes an association status.

Members

AdditionalInfo

Type: string

A user-defined string.

Date

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

The date when the status changed.

Message

Required: Yes
Type: string

The reason for the status.

Name

Required: Yes
Type: string

The status.

AssociationVersionInfo

Description

Information about the association version.

Members

AssociationId

Type: string

The ID created by the system when the association was created.

AssociationName

Type: string

The name specified for the association version when the association version was created.

AssociationVersion

Type: string

The association version.

ComplianceSeverity

Type: string

The severity level that is assigned to the association.

CreatedDate

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

The date the association version was created.

DocumentVersion

Type: string

The version of a Systems Manager document used when the association version was created.

MaxConcurrency

Type: string

MaxErrors

Type: string

Name

Type: string

The name specified when the association was created.

OutputLocation

Type: InstanceAssociationOutputLocation structure

The location in Amazon S3 specified for the association when the association version was created.

Parameters

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

Parameters specified when the association version was created.

ScheduleExpression

Type: string

The cron or rate schedule specified for the association when the association version was created.

Targets

Type: Array of Target structures

The targets specified for the association when the association version was created.

AssociationVersionLimitExceeded

Description

You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.

Members

Message

Type: string

AttachmentContent

Description

A structure that includes attributes that describe a document attachment.

Members

Hash

Type: string

The cryptographic hash value of the document content.

HashType

Type: string

The hash algorithm used to calculate the hash value.

Name

Type: string

The name of an attachment.

Size

Type: long (int|float)

The size of an attachment in bytes.

Url

Type: string

The URL location of the attachment content.

AttachmentInformation

Description

An attribute of an attachment, such as the attachment name.

Members

Name

Type: string

The name of the attachment.

AttachmentsSource

Description

A key and value pair that identifies the location of an attachment to a document.

Members

Key

Type: string

The key of a key and value pair that identifies the location of an attachment to a document.

Values

Type: Array of strings

Type: string

The execution ID.

AutomationExecutionStatus

Type: string

The execution status of the Automation.

CurrentAction

Type: string

The action of the step that is currently running.

CurrentStepName

Type: string

The name of the step that is currently running.

DocumentName

Type: string

The name of the Automation document used during the execution.

DocumentVersion

Type: string

The version of the document to use during execution.

ExecutedBy

Type: string

The Amazon Resource Name (ARN) of the user who ran the automation.

ExecutionEndTime

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

The time the execution finished.

ExecutionStartTime

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

The time the execution started.

FailureMessage

Type: string

A message describing why an execution has failed, if the status is set to Failed.

MaxConcurrency

Type: string

The MaxConcurrency value specified by the user when the execution started.

MaxErrors

Type: string

The MaxErrors value specified by the user when the execution started.

Mode

Type: string

The automation execution mode.

Outputs

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

The list of execution outputs as defined in the automation document.

Parameters

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

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

ParentAutomationExecutionId

Type: string

The AutomationExecutionId of the parent automation.

ProgressCounters

Type: ProgressCounters structure

An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

ResolvedTargets

Type: ResolvedTargets structure

A list of resolved targets in the rate control execution.

StepExecutions

Type: Array of StepExecution structures

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.

StepExecutionsTruncated

Type: boolean

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.

Target

Type: string

The target of the execution.

TargetLocations

Type: Array of TargetLocation structures

The combination of AWS Regions and/or AWS accounts where you want to run the Automation.

TargetMaps

Type: Array of maps

The specified key-value mapping of document parameters to target resources.

TargetParameterName

Type: string

The parameter name.

Targets

Type: Array of Target structures

The specified targets.

AutomationExecutionFilter

Description

A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.

Members

Key

Required: Yes
Type: string

One or more keys to limit the results. Valid filter keys include the following: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter.

Values

Required: Yes
Type: Array of strings

The values used to limit the execution information associated with the filter's key.

AutomationExecutionLimitExceededException

Description

The number of simultaneously running Automation executions exceeded the allowable limit.

Members

Message

Type: string

AutomationExecutionMetadata

Description

Details about a specific Automation execution.

Members

AutomationExecutionId

Type: string

The execution ID.

AutomationExecutionStatus

Type: string

The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.

AutomationType

Type: string

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

CurrentAction

Type: string

The action of the step that is currently running.

CurrentStepName

Type: string

The name of the step that is currently running.

DocumentName

Type: string

The name of the Automation document used during execution.

DocumentVersion

Type: string

The document version used during the execution.

ExecutedBy

Type: string

The IAM role ARN of the user who ran the Automation.

ExecutionEndTime

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

The time the execution finished. This is not populated if the execution is still in progress.

ExecutionStartTime

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

The time the execution started.>

FailureMessage

Type: string

The list of execution outputs as defined in the Automation document.

LogFile

Type: string

An Amazon S3 bucket where execution information is stored.

MaxConcurrency

Type: string

The MaxConcurrency value specified by the user when starting the Automation.

MaxErrors

Type: string

The MaxErrors value specified by the user when starting the Automation.

Mode

Type: string

The Automation execution mode.

Outputs

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

The list of execution outputs as defined in the Automation document.

ParentAutomationExecutionId

Type: string

The ExecutionId of the parent Automation.

ResolvedTargets

Type: ResolvedTargets structure

A list of targets that resolved during the execution.

Target

Type: string

The list of execution outputs as defined in the Automation document.

TargetMaps

Type: Array of maps

The specified key-value mapping of document parameters to target resources.

TargetParameterName

Type: string

The list of execution outputs as defined in the Automation document.

Targets

Type: Array of Target structures

Type: string

The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.

CloudWatchOutputEnabled

Type: boolean

Enables Systems Manager to send command output to CloudWatch Logs.

Command

Description

Describes a command request.

Members

CloudWatchOutputConfig

Type: CloudWatchOutputConfig structure

CloudWatch Logs information where you want Systems Manager to send the command output.

CommandId

Type: string

A unique identifier for this command.

Comment

Type: string

User-specified information about the command, such as a brief description of what the command should do.

CompletedCount

Type: int

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

DeliveryTimedOutCount

Type: int

The number of targets for which the status is Delivery Timed Out.

DocumentName

Type: string

The name of the document requested for execution.

DocumentVersion

Type: string

The SSM document version.

ErrorCount

Type: int

The number of targets for which the status is Failed or Execution Timed Out.

ExpiresAfter

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

If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

InstanceIds

Type: Array of strings

The instance IDs against which this command was requested.

MaxConcurrency

Type: string

The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.

MaxErrors

Type: string

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.

NotificationConfig

Type: NotificationConfig structure

Configurations for sending notifications about command status changes.

OutputS3BucketName

Type: string

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

OutputS3KeyPrefix

Type: string

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

OutputS3Region

Type: string

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

Parameters

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

The parameter values to be inserted in the document when running the command.

RequestedDateTime

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

The date and time the command was requested.

ServiceRole

Type: string

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Status

Type: string

The status of the command.

StatusDetails

Type: string

A detailed status of the command execution. 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 any instances.
In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.
Success: The command successfully ran on all invocations. This is a terminal state.
Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

TargetCount

Type: int

The number of targets for the command.

Targets

Type: Array of Target structures

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

CommandFilter

Description

Describes a command filter.

Members

key

Required: Yes
Type: string

The name of the filter.

value

Required: Yes
Type: string

The filter value. Valid values for each filter key are as follows:

InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions occurring July 7, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions from before July 7, 2018.
Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:
- Pending
- InProgress
- Success
- Cancelled
- Failed
- TimedOut
- Cancelling
DocumentName: Specify name of the SSM document for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances.
ExecutionStage: Specify one of the following values:
- Executing: Returns a list of command executions that are currently still running.
- Complete: Returns a list of command executions that have already completed.

CommandInvocation

Description

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. A command invocation returns status and detail information about a command you ran.

Members

CloudWatchOutputConfig

Type: CloudWatchOutputConfig structure

CloudWatch Logs information where you want Systems Manager to send the command output.

CommandId

Type: string

The command against which this invocation was requested.

CommandPlugins

Type: Array of CommandPlugin structures

Comment

Type: string

User-specified information about the command, such as a brief description of what the command should do.

DocumentName

Type: string

The document name that was requested for execution.

DocumentVersion

Type: string

The SSM document version.

InstanceId

Type: string

The instance ID in which this invocation was requested.

InstanceName

Type: string

The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.

NotificationConfig

Type: NotificationConfig structure

Configurations for sending notifications about command status changes on a per instance basis.

RequestedDateTime

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

The time and date the request was sent to this instance.

ServiceRole

Type: string

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.

StandardErrorUrl

Type: string

The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

StandardOutputUrl

Type: string

The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

Status

Type: string

Whether or not the invocation succeeded, failed, or is pending.

StatusDetails

Type: string

A detailed status of the command execution for each invocation (each instance targeted by the command). 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.
Success: The execution of the command or plugin was successfully completed. 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: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command was not successful 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.

TraceOutput

Type: string

Gets the trace output sent by the agent.

CommandPlugin

Description

Describes plugin details.

Members

Name

Type: string

The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.

Output

Type: string

Output of the plugin execution.

OutputS3BucketName

Type: string

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

test_folder is the name of the Amazon S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-1234567876543 is the instance ID;

awsrunShellScript is the name of the plugin.

OutputS3KeyPrefix

Type: string

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

test_folder is the name of the Amazon S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-1234567876543 is the instance ID;

awsrunShellScript is the name of the plugin.

OutputS3Region

Type: string

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

ResponseCode

Type: int

A numeric response code generated after running the plugin.

ResponseFinishDateTime

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

The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.

ResponseStartDateTime

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

The time the plugin started running.

StandardErrorUrl

Type: string

The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.

StandardOutputUrl

Type: string

The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.

Status

Type: string

The status of this plugin. You can run a document with multiple plugins.

StatusDetails

Type: string

A detailed status of the plugin execution. 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.
Success: The execution of the command or plugin was successfully completed. 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: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command was not successful 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 it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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.

ComplianceExecutionSummary

Description

Members

ExecutionId

Type: string

An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.

ExecutionTime

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

The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

ExecutionType

Type: string

The type of execution. For example, Command is a valid execution type.

ComplianceItem

Description

Information about the compliance as defined by the resource type. For example, for a patch resource type, Items includes information about the PatchSeverity, Classification, etc.

Members

ComplianceType

Type: string

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

Details

Type: Associative array of custom strings keys (AttributeName) to strings

A "Key": "Value" tag combination for the compliance item.

ExecutionSummary

Type: ComplianceExecutionSummary structure

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

Id

Type: string

An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.

ResourceId

Type: string

An ID for the resource. For a managed instance, this is the instance ID.

ResourceType

Type: string

The type of resource. ManagedInstance is currently the only supported resource type.

Severity

Type: string

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

Status

Type: string

The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

Title

Type: string

A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

ComplianceItemEntry

Description

Information about a compliance item.

Members

Details

Type: Associative array of custom strings keys (AttributeName) to strings

A "Key": "Value" tag combination for the compliance item.

Id

Type: string

The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.

Severity

Required: Yes
Type: string

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

Status

Required: Yes
Type: string

The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

Title

Type: string

The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

ComplianceStringFilter

Description

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

Members

Key

Type: string

The name of the filter.

Type

Type: string

The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.

Values

Type: Array of strings

The value for which to search.

ComplianceSummaryItem

Description

A summary of compliance information by compliance type.

Members

ComplianceType

Type: string

The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.

CompliantSummary

Type: CompliantSummary structure

A list of COMPLIANT items for the specified compliance type.

NonCompliantSummary

Type: NonCompliantSummary structure

A list of NON_COMPLIANT items for the specified compliance type.

ComplianceTypeCountLimitExceededException

Description

You specified too many custom compliance types. You can specify a maximum of 10 different types.

Members

Message

Type: string

CompliantSummary

Description

A summary of resources that are compliant. The summary is organized according to the resource count for each compliance type.

Members

CompliantCount

Type: int

The total number of resources that are compliant.

SeveritySummary

Type: SeveritySummary structure

A summary of the compliance severity by compliance type.

CreateAssociationBatchRequestEntry

Description

Describes the association of a Systems Manager SSM document and an instance.

Members

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.

InstanceId

Type: string

The ID of the instance.

MaxConcurrency

Type: string

MaxErrors

Type: string

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: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 Amazon S3 bucket where you want to store the results of this request.

Parameters

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

A description of the parameters for a document.

ScheduleExpression

Type: string

A cron expression that specifies a schedule when the association runs.

Targets

Type: Array of Target structures

The instances targeted by the request.

CustomSchemaCountLimitExceededException

Description

You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.

Members

Message

Type: string

DescribeActivationsFilter

Description

Filter for the DescribeActivation API.

Members

FilterKey

Type: string

The name of the filter.

FilterValues

Type: Array of strings

The filter values.

DocumentAlreadyExists

Description

The specified document already exists.

Members

Message

Type: string

DocumentDefaultVersionDescription

Description

A default version of a document.

Members

DefaultVersion

Type: string

The default version of the document.

DefaultVersionName

Type: string

The default version of the artifact associated with the document.

Name

Type: string

The name of the document.

DocumentDescription

Description

Describes a Systems Manager document.

Members

AttachmentsInformation

Type: Array of AttachmentInformation structures

Details about the document attachments, including names, locations, sizes, etc.

CreatedDate

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

The date when the document was created.

DefaultVersion

Type: string

The default version.

Description

Type: string

A description of the document.

DocumentFormat

Type: string

The document format, either JSON or YAML.

DocumentType

Type: string

The type of document.

DocumentVersion

Type: string

The document version.

Hash

Type: string

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

HashType

Type: string

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

LatestVersion

Type: string

The latest version of the document.

Name

Type: string

The name of the Systems Manager document.

Owner

Type: string

The AWS user account that created the document.

Parameters

Type: Array of DocumentParameter structures

A description of the parameters for a document.

PlatformTypes

Type: Array of strings

The list of OS platforms compatible with this Systems Manager document.

SchemaVersion

Type: string

The schema version.

Sha1

Type: string

The SHA1 hash of the document, which you can use for verification.

Status

Type: string

The status of the Systems Manager document.

StatusInformation

Type: string

Tags

Type: Array of Tag structures

The tags, or metadata, that have been applied to the document.

TargetType

Type: string

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.

VersionName

Type: string

The version of the artifact associated with the document.

DocumentFilter

Description

Describes a filter.

Members

key

Required: Yes
Type: string

The name of the filter.

value

Required: Yes
Type: string

The value of the filter.

DocumentIdentifier

Description

Describes the name of a Systems Manager document.

Members

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.

Owner

Type: string

The AWS user account that created the document.

PlatformTypes

Type: Array of strings

The operating system platform.

SchemaVersion

Type: string

The schema version.

Tags

Type: Array of Tag structures

The tags, or metadata, that have been applied to the document.

TargetType

Type: string

VersionName

Type: string

DocumentKeyValuesFilter

Description

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

For keys, you can specify one or more tags that have been applied to a document.

Other valid values include Owner, Name, PlatformTypes, and DocumentType.

Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.

If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the AWS CLI, to return a list of all documents that begin with Te, run the following command:

aws ssm list-documents --filters Key=Name,Values=Te

If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.

To specify a custom key and value pair, use the format Key=tag:[tagName],Values=[valueName].

For example, if you created a Key called region and are using the AWS CLI to call the list-documents command:

aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self

Members

Key

Type: string

The name of the filter key.

Values

Type: Array of strings

The value for the filter key.

DocumentLimitExceeded

Description

You can have at most 200 active Systems Manager documents.

Members

Message

Type: string

DocumentParameter

Description

Parameters specified in a System Manager document that run on the server when the command is run.

Members

DefaultValue

Type: string

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

Description

Type: string

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

Name

Type: string

The name of the parameter.

Type

Type: string

The type of parameter. The type can be either String or StringList.

DocumentPermissionLimit

Description

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.

Members

Message

Type: string

DocumentVersionInfo

Description

Version information about the document.

Members

CreatedDate

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

The date the document was created.

DocumentFormat

Type: string

The document format, either JSON or YAML.

DocumentVersion

Type: string

The document version.

IsDefaultVersion

Type: boolean

An identifier for the default version of the document.

Name

Type: string

The document name.

Status

Type: string

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

StatusInformation

Type: string

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.

DocumentVersionLimitExceeded

Description

The document has too many versions. Delete one or more document versions and try again.

Members

Message

Type: string

DoesNotExistException

Description

Error returned when the ID specified for a resource, such as a Maintenance Window or Patch baseline, doesn't exist.

For information about resource limits in Systems Manager, see AWS Systems Manager Limits.

Members

Message

Type: string

DuplicateDocumentContent

Description

The content of the association document matches another document. Change the content of the document and try again.

Members

Message

Type: string

DuplicateDocumentVersionName

Description

The version name has already been used in this document. Specify a different version name, and then try again.

Members

Message

Type: string

DuplicateInstanceId

Description

You cannot specify an instance ID in more than one association.

Members

EffectivePatch

Description

The EffectivePatch structure defines metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

Members

Patch

Type: Patch structure

Provides metadata for a patch, including information such as the KB ID, severity, classification and a URL for where more information can be obtained about the patch.

PatchStatus

Type: PatchStatus structure

The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

FailedCreateAssociation

Description

Describes a failed association.

Members

Entry

Type: CreateAssociationBatchRequestEntry structure

The association.

Fault

Type: string

The source of the failure.

Message

Type: string

A description of the failure.

FailureDetails

Description

Information about an Automation failure.

Members

Details

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

Detailed information about the Automation step failure.

FailureStage

Type: string

The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.

FailureType

Type: string

The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.

FeatureNotAvailableException

Description

You attempted to register a LAMBDA or STEP_FUNCTION task in a region where the corresponding service is not available.

Members

Message

Type: string

HierarchyLevelLimitExceededException

Description

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.

Members

message

Type: string

Type: string

Detailed status information about the aggregated associations.

InstanceAssociationStatusAggregatedCount

Type: Associative array of custom strings keys (StatusName) to ints

The number of associations for the instance(s).

InstanceAssociation

Description

One or more association documents on the instance.

Members

AssociationId

Type: string

The association ID.

AssociationVersion

Type: string

Version information for the association on the instance.

Content

Type: string

The content of the association document for the instance(s).

InstanceId

Type: string

The instance ID.

InstanceAssociationOutputLocation

Description

An Amazon S3 bucket where you want to store the results of this request.

Members

S3Location

Type: S3OutputLocation structure

An Amazon S3 bucket where you want to store the results of this request.

InstanceAssociationOutputUrl

Description

The URL of Amazon S3 bucket where you want to store the results of this request.

Members

S3OutputUrl

Type: S3OutputUrl structure

The URL of Amazon S3 bucket where you want to store the results of this request.

InstanceAssociationStatusInfo

Description

Status information about the instance association.

Members

AssociationId

Type: string

The association ID.

AssociationName

Type: string

The name of the association applied to the instance.

AssociationVersion

Type: string

The version of the association applied to the instance.

DetailedStatus

Type: string

Detailed status information about the instance association.

DocumentVersion

Type: string

The association document verions.

ErrorCode

Type: string

An error code returned by the request to create the association.

ExecutionDate

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

The date the instance association ran.

ExecutionSummary

Type: string

Summary information about association execution.

InstanceId

Type: string

The instance ID where the association was created.

Name

Type: string

The name of the association.

OutputUrl

Type: InstanceAssociationOutputUrl structure

A URL for an Amazon S3 bucket where you want to store the results of this request.

Status

Type: string

Status information about the instance association.

InstanceInformation

Description

Describes a filter for a specific list of instances.

Members

ActivationId

Type: string

The activation ID created by Systems Manager when the server or VM was registered.

AgentVersion

Type: string

The version of SSM Agent running on your Linux instance.

AssociationOverview

Type: InstanceAggregatedAssociationOverview structure

Information about the association.

AssociationStatus

Type: string

The status of the association.

ComputerName

Type: string

The fully qualified host name of the managed instance.

IPAddress

Type: string

The IP address of the managed instance.

IamRole

Type: string

The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 instances.

InstanceId

Type: string

The instance ID.

IsLatestVersion

Type: boolean

Indicates whether latest version of SSM Agent is running on your instance. Some older versions of Windows Server use the EC2Config service to process SSM requests. For this reason, this field does not indicate whether or not the latest version is installed on Windows managed instances.

LastAssociationExecutionDate

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

The date the association was last run.

LastPingDateTime

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

The date and time when agent last pinged Systems Manager service.

LastSuccessfulAssociationExecutionDate

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

The last date the association was successfully run.

Name

Type: string

The name of the managed instance.

PingStatus

Type: string

Connection status of SSM Agent.

PlatformName

Type: string

The name of the operating system platform running on your instance.

PlatformType

Type: string

The operating system platform type.

PlatformVersion

Type: string

The version of the OS platform running on your instance.

RegistrationDate

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

The date the server or VM was registered with AWS as a managed instance.

ResourceType

Type: string

The type of instance. Instances are either EC2 instances or managed instances.

InstanceInformationFilter

Description

Describes a filter for a specific list of instances. You can filter instances information by using tags. You specify tags by using a key-value mapping.

Use this action instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The InstanceInformationFilterList method is a legacy method and does not support tags.

Members

key

Required: Yes
Type: string

The name of the filter.

valueSet

Required: Yes
Type: Array of strings

The filter values.

InstanceInformationStringFilter

Description

The filters to describe or get information about your managed instances.

Members

Key

Required: Yes
Type: string

The filter key name to describe your instances. For example:

Values

Required: Yes
Type: Array of strings

The filter values.

InstancePatchState

Description

Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.

Members

BaselineId

Required: Yes
Type: string

The ID of the patch baseline used to patch the instance.

FailedCount

Type: int

The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

InstallOverrideList

Type: string

An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.

InstalledCount

Type: int

The number of patches from the patch baseline that are installed on the instance.

InstalledOtherCount

Type: int

The number of patches not specified in the patch baseline that are installed on the instance.

InstalledRejectedCount

Type: int

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

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

InstanceId

Required: Yes
Type: string

The ID of the managed instance the high-level patch compliance information was collected for.

MissingCount

Type: int

The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.

NotApplicableCount

Type: int

The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.

Operation

Required: Yes
Type: string

The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

OperationEndTime

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

The time the most recent patching operation completed on the instance.

OperationStartTime

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

The time the most recent patching operation was started on the instance.

OwnerInformation

Type: string

Placeholder information. This field will always be empty in the current release of the service.

PatchGroup

Required: Yes
Type: string

The name of the patch group the managed instance belongs to.

SnapshotId

Type: string

The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

UnreportedNotApplicableCount

Type: int

The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.

InstancePatchStateFilter

Description

Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to scope down the information returned by the API.

Members

Key

Required: Yes
Type: string

The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.

Type

Required: Yes
Type: string

The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.

Values

Required: Yes
Type: Array of strings

Type: string

Type: string

InvalidCommandId

Type: string

The document does not exist or the document is not available to the user. This exception can be issued by CreateAssociation, CreateAssociationBatch, DeleteAssociation, DeleteDocument, DescribeAssociation, DescribeDocument, GetDocument, SendCommand, or UpdateAssociationStatus.

InvalidDocumentContent

Description

The content for the document is not valid.

Members

Message

Type: string

Type: string

InvalidFilterKey

Description

The specified key is not valid.

Members

InvalidFilterOption

Description

The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

Members

message

Type: string

The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

InvalidFilterValue

Description

The filter value is not valid. Verify the value and try again.

Members

Message

Type: string

InvalidInstanceId

Description

The following problems can cause this exception:

You do not have permission to access the instance.

SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling SSM Agent or EC2Config service.

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

Members

Message

Type: string

InvalidInstanceInformationFilterValue

Description

The specified filter value is not valid.

Members

message

Type: string

InvalidInventoryGroupException

Description

The specified inventory group is not valid.

Members

Message

Type: string

InvalidInventoryItemContextException

Description

You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again.

Members

Message

Type: string

InvalidInventoryRequestException

Description

The request is not valid.

Members

Message

Type: string

InvalidItemContentException

Description

One or more content items is not valid.

Members

Message

Type: string

TypeName

Type: string

InvalidKeyId

Description

The query key ID is not valid.

Members

message

Type: string

InvalidNextToken

Description

The specified token is not valid.

Members

Message

Type: string

InvalidNotificationConfig

Description

One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.

Members

Message

Type: string

InvalidOptionException

Description

The delete inventory option specified is not valid. Verify the option and try again.

Members

Message

Type: string

InvalidOutputFolder

Description

The S3 bucket does not exist.

Members

InvalidOutputLocation

Members

InvalidPolicyAttributeException

Description

A policy attribute or its value is invalid.

Members

message

Type: string

InvalidPolicyTypeException

Description

The policy type is not supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

Members

message

Type: string

InvalidResourceId

Description

The resource ID is not valid. Verify that you entered the correct ID and try again.

Members

InvalidResourceType

Members

Aggregators

Type: Array of InventoryAggregator structures

Nested aggregators to further refine aggregation for an inventory type.

Expression

Type: string

The inventory type and attribute name for aggregation.

Groups

Type: Array of InventoryGroup structures

A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.

InventoryDeletionStatusItem

Description

Status information returned by the DeleteInventory action.

Members

DeletionId

Type: string

The deletion ID returned by the DeleteInventory action.

DeletionStartTime

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

The UTC timestamp when the delete operation started.

DeletionSummary

Type: InventoryDeletionSummary structure

Information about the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.

LastStatus

Type: string

The status of the operation. Possible values are InProgress and Complete.

LastStatusMessage

Type: string

Information about the status.

LastStatusUpdateTime

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

The UTC timestamp of when the last status report.

TypeName

Type: string

The name of the inventory data type.

InventoryDeletionSummary

Description

Information about the delete operation.

Members

RemainingCount

Type: int

Remaining number of items to delete.

SummaryItems

Type: Array of InventoryDeletionSummaryItem structures

A list of counts and versions for deleted items.

TotalCount

Type: int

The total number of items to delete. This count does not change during the delete operation.

InventoryDeletionSummaryItem

Description

Either a count, remaining count, or a version number in a delete inventory summary.

Members

Count

Type: int

A count of the number of deleted items.

RemainingCount

Type: int

The remaining number of items to delete.

Version

Type: string

The inventory type version.

InventoryFilter

Description

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

Members

Key

Required: Yes
Type: string

The name of the filter key.

Type

Type: string

The type of filter. Valid values include the following: "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"

Values

Required: Yes
Type: Array of strings

Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal

InventoryGroup

Description

A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.

Members

Filters

Required: Yes
Type: Array of InventoryFilter structures

Filters define the criteria for the group. The matchingCount field displays the number of resources that match the criteria. The notMatchingCount field displays the number of resources that don't match the criteria.

Name

Required: Yes
Type: string

The name of the group.

InventoryItem

Description

Information collected from managed instances based on your inventory policy document

Members

CaptureTime

Required: Yes
Type: string

The time the inventory information was collected.

Content

Type: Array of stringss

The inventory data of the inventory type.

ContentHash

Type: string

MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.

Context

Type: Associative array of custom strings keys (AttributeName) to strings

A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType properties of the AWS:ComplianceItem type.

SchemaVersion

Required: Yes
Type: string

The schema version for the inventory item.

TypeName

Required: Yes
Type: string

The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

InventoryItemAttribute

Description

Attributes are the entries within the inventory item content. It contains name and value.

Members

DataType

Required: Yes
Type: string

The data type of the inventory item attribute.

Name

Required: Yes
Type: string

Name of the inventory item attribute.

InventoryItemSchema

Description

The inventory item schema definition. Users can use this to compose inventory query filters.

Members

Attributes

Required: Yes
Type: Array of InventoryItemAttribute structures

The schema attributes for inventory. This contains data type and attribute name.

DisplayName

Type: string

The alias name of the inventory type. The alias name is used for display purposes.

TypeName

Required: Yes
Type: string

Version

Type: string

The schema version for the inventory item.

InventoryResultEntity

Description

Inventory query results.

Members

Data

Type: Associative array of custom strings keys (InventoryResultItemKey) to InventoryResultItem structures

The data section in the inventory result entity JSON.

Id

Type: string

ID of the inventory result entity. For example, for managed instance inventory the result will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.

InventoryResultItem

Description

The inventory result item.

Members

CaptureTime

Type: string

The time inventory item data was captured.

Content

Required: Yes
Type: Array of stringss

Contains all the inventory data of the item type. Results include attribute names and values.

ContentHash

Type: string

SchemaVersion

Required: Yes
Type: string

The schema version for the inventory result item/

TypeName

Required: Yes
Type: string

The name of the inventory result item type.

InvocationDoesNotExist

Description

The command ID and instance ID you specified did not match any invocations. Verify the command ID adn the instance ID and try again.

Members

ItemContentMismatchException

Description

The inventory item has invalid content.

Members

Message

Type: string

TypeName

Type: string

ItemSizeLimitExceededException

Description

The inventory item size has exceeded the size limit.

Members

Message

Type: string

TypeName

Type: string

LoggingInfo

Description

Information about an Amazon S3 bucket to write instance-level logs to.

Members

S3BucketName

Required: Yes
Type: string

The name of an Amazon S3 bucket where execution logs are stored .

S3KeyPrefix

Type: string

(Optional) The Amazon S3 bucket subfolder.

S3Region

Required: Yes
Type: string

The region where the Amazon S3 bucket is located.

MaintenanceWindowAutomationParameters

Description

The parameters for an AUTOMATION task type.

Members

DocumentVersion

Type: string

The version of an Automation document to use during task execution.

Parameters

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

The parameters for the

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Simple Systems Manager (SSM) 2014-11-06

Operation Summary

Paginators

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

CreatePatchBaseline

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors