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

AddTagsToResource

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

• InvalidCommandId:

  This error does not currently have a description.

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

• DuplicateInstanceId:

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

CancelMaintenanceWindowExecution

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

• DoesNotExistException:

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

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

CreateActivation

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

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

Result Syntax

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

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

CreateAssociation

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

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

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

Errors

• AssociationAlreadyExists:

  The specified association already exists.

• AssociationLimitExceeded:

  You can have at most 2,000 active associations.

• InternalServerError:

  An error occurred on the server side.

• InvalidDocument:

  The specified document does not exist.

• InvalidDocumentVersion:

  The document version is not valid or does not exist.

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

• UnsupportedPlatformType:

  The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.

• InvalidOutputLocation:

  The output location is not valid or does not exist.

• InvalidParameters:

  You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.

• InvalidTarget:

  The target is not valid or does not exist. It might not be configured for 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([/* ... */]);

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

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

Errors

• InternalServerError:

  An error occurred on the server side.

• InvalidDocument:

  The specified document does not exist.

• InvalidDocumentVersion:

  The document version is not valid or does not exist.

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

• InvalidParameters:

  You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.

• DuplicateInstanceId:

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

• AssociationLimitExceeded:

  You can have at most 2,000 active associations.

• UnsupportedPlatformType:

  The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.

• InvalidOutputLocation:

  The output location is not valid or does not exist.

• InvalidTarget:

  The target is not valid or does not exist. It might not be configured for 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DocumentDescription' => [
        'AttachmentsInformation' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'CreatedDate' => <DateTime>,
        'DefaultVersion' => '<string>',
        'Description' => '<string>',
        'DocumentFormat' => 'YAML|JSON|TEXT',
        'DocumentType' => 'Command|Policy|Automation|Session|Package|ApplicationConfiguration|ApplicationConfigurationSchema|DeploymentStrategy|ChangeCalendar',
        '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>', ...],
        'Requires' => [
            [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'SchemaVersion' => '<string>',
        'Sha1' => '<string>',
        'Status' => 'Creating|Active|Updating|Deleting|Failed',
        'StatusInformation' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TargetType' => '<string>',
        'VersionName' => '<string>',
    ],
]

Result Details

Errors

• DocumentAlreadyExists:

  The specified document already exists.

• MaxDocumentSizeExceeded:

  The size limit of a document is 64 KB.

• InternalServerError:

  An error occurred on the server side.

• InvalidDocumentContent:

  The content for the document is not valid.

• DocumentLimitExceeded:

  You can have at most 500 active Systems Manager documents.

• InvalidDocumentSchemaVersion:

  The version of the document schema is not supported.

CreateMaintenanceWindow

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

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

Result Syntax

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

Result Details

Errors

• IdempotentParameterMismatch:

  Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

• ResourceLimitExceededException:

  Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

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

• InternalServerError:

  An error occurred on the server side.

CreateOpsItem

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

• OpsItemAlreadyExistsException:

  The OpsItem already exists.

• OpsItemLimitExceededException:

  The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.

• OpsItemInvalidParameterException:

  A specified parameter argument isn't valid. Verify the available arguments and try again.

CreatePatchBaseline

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

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

Result Syntax

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

Result Details

Errors

• IdempotentParameterMismatch:

  Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

• ResourceLimitExceededException:

  Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

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

• InternalServerError:

  An error occurred on the server side.

CreateResourceDataSync

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• AssociationDoesNotExist:

  The specified association does not exist.

• InternalServerError:

  An error occurred on the server side.

• InvalidDocument:

  The specified document does not exist.

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

• TooManyUpdates:

  There are concurrent updates for a resource that supports one update at a time.

DeleteDocument

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

DeleteParameter

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

DeletePatchBaseline

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

• ResourceDataSyncNotFoundException:

  The specified sync name was not found.

• ResourceDataSyncInvalidConfigurationException:

  The specified sync configuration is invalid.

DeregisterManagedInstance

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

• InternalServerError:

  An error occurred on the server side.

DeregisterPatchBaselineForPatchGroup

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• DoesNotExistException:

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

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

• InternalServerError:

  An error occurred on the server side.

• TargetInUseException:

  You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

DeregisterTaskFromMaintenanceWindow

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• DoesNotExistException:

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

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

• InternalServerError:

  An error occurred on the server side.

DescribeActivations

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

Parameter Syntax

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

Parameter Details

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

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

Parameter Syntax

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

Parameter Details

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

Errors

• AssociationDoesNotExist:

  The specified association does not exist.

• InvalidAssociationVersion:

  The version you specified is not valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.

• InternalServerError:

  An error occurred on the server side.

• InvalidDocument:

  The specified document does not exist.

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

DescribeAssociationExecutionTargets

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

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

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

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

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

Result Syntax

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

Result Details

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

Parameter Syntax

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

Parameter Details

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

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

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

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

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

Parameter Syntax

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

Parameter Details

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

Errors

• InternalServerError:

  An error occurred on the server side.

DescribeDocument

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Document' => [
        'AttachmentsInformation' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'CreatedDate' => <DateTime>,
        'DefaultVersion' => '<string>',
        'Description' => '<string>',
        'DocumentFormat' => 'YAML|JSON|TEXT',
        'DocumentType' => 'Command|Policy|Automation|Session|Package|ApplicationConfiguration|ApplicationConfigurationSchema|DeploymentStrategy|ChangeCalendar',
        '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>', ...],
        'Requires' => [
            [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'SchemaVersion' => '<string>',
        'Sha1' => '<string>',
        'Status' => 'Creating|Active|Updating|Deleting|Failed',
        'StatusInformation' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TargetType' => '<string>',
        'VersionName' => '<string>',
    ],
]

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

• InvalidNextToken:

  The specified token is not valid.

DescribeEffectivePatchesForPatchBaseline

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

Parameter Syntax

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

Parameter Details

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

Errors

• InvalidResourceId:

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

• DoesNotExistException:

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

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

• UnsupportedOperatingSystem:

  The operating systems you specified is not supported, or the operation is not supported for the operating system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.

• InternalServerError:

  An error occurred on the server side.

DescribeInstanceAssociationsStatus

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

Parameter Syntax

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

Parameter Details

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

Errors

• InternalServerError:

  An error occurred on the server side.

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

• InvalidNextToken:

  The specified token is not valid.

DescribeInstanceInformation

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

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

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

Errors

• InternalServerError:

  An error occurred on the server side.

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

• InvalidNextToken:

  The specified token is not valid.

• InvalidInstanceInformationFilterValue:

  The specified filter value is not valid.

• InvalidFilterKey:

  The specified key is not valid.

DescribeInstancePatchStates

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

• InvalidNextToken:

  The specified token is not valid.

DescribeInstancePatchStatesForPatchGroup

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

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

Result Syntax

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

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InternalServerError:

  An error occurred on the server side.

• InvalidInstanceId:

  The following problems can cause this exception:

  You do not have permission to access the instance.

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

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

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

• InvalidFilter:

  The filter name is not valid. Verify the you entered the correct name and try again.

• InvalidNextToken:

  The specified token is not valid.

DescribeInventoryDeletions

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

Parameter Syntax

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

Parameter Details

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

Errors

• InternalServerError:

  An error occurred on the server side.

• InvalidDeletionIdException:

  The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.

• InvalidNextToken:

  The specified token is not valid.

DescribeMaintenanceWindowExecutionTaskInvocations

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

Parameter Syntax

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

Parameter Details

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

Errors

• DoesNotExistException:

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

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

• InternalServerError:

  An error occurred on the server side.

DescribeMaintenanceWindowExecutionTasks

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

Parameter Syntax

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

Parameter Details

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

Errors

• DoesNotExistException:

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

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

• InternalServerError:

  An error occurred on the server side.

DescribeMaintenanceWindowExecutions

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

Parameter Syntax

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

Parameter Details

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

Errors

• InternalServerError:

  An error occurred on the server side.

DescribeMaintenanceWindowSchedule

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

Parameter Syntax

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

Parameter Details