using AWSSDK.SSM.add_tags_to_resource
add_tags_to_resource([::AWSConfig], arguments::Dict)
add_tags_to_resource([::AWSConfig]; ResourceType=, ResourceId=, Tags=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "AddTagsToResource", arguments::Dict)
ssm([::AWSConfig], "AddTagsToResource", ResourceType=, ResourceId=, Tags=)

AddTagsToResource Operation

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

Each resource can have a maximum of 10 tags.

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

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

Arguments

ResourceType = "Document", "ManagedInstance", "MaintenanceWindow", "Parameter" or "PatchBaseline" – Required

Specifies the type of resource you are tagging.

ResourceId = ::String – Required

The resource ID you want to tag.

For the ManagedInstance, MaintenanceWindow, and PatchBaseline values, use the ID of the resource, such as mw-01234361858c9b57b for a Maintenance Window.

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

Tags = [[ ... ], ...] – Required

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.

 Tags = [[
        "Key" => <required> ::String,
        "Value" => <required> ::String
    ], ...]

Returns

AddTagsToResourceResult

Exceptions

InvalidResourceType, InvalidResourceId, InternalServerError or TooManyTagsError.

See also: AWS API Documentation

using AWSSDK.SSM.cancel_command
cancel_command([::AWSConfig], arguments::Dict)
cancel_command([::AWSConfig]; CommandId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "CancelCommand", arguments::Dict)
ssm([::AWSConfig], "CancelCommand", CommandId=, <keyword arguments>)

CancelCommand Operation

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.

Arguments

CommandId = ::String – Required

The ID of the command you want to cancel.

InstanceIds = [::String, ...]

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

Returns

CancelCommandResult

Exceptions

InternalServerError, InvalidCommandId, InvalidInstanceId or DuplicateInstanceId.

See also: AWS API Documentation

using AWSSDK.SSM.create_activation
create_activation([::AWSConfig], arguments::Dict)
create_activation([::AWSConfig]; IamRole=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "CreateActivation", arguments::Dict)
ssm([::AWSConfig], "CreateActivation", IamRole=, <keyword arguments>)

CreateActivation Operation

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.

Arguments

Description = ::String

A userdefined description of the resource that you want to register with Amazon EC2.

DefaultInstanceName = ::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.

IamRole = ::String – Required

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

RegistrationLimit = ::Int

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

ExpirationDate = timestamp

The date by which this activation request should expire. The default value is 24 hours.

Returns

CreateActivationResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.create_association
create_association([::AWSConfig], arguments::Dict)
create_association([::AWSConfig]; Name=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "CreateAssociation", arguments::Dict)
ssm([::AWSConfig], "CreateAssociation", Name=, <keyword arguments>)

CreateAssociation Operation

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

Arguments

Name = ::String – Required

The name of the Systems Manager document.

DocumentVersion = ::String

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

InstanceId = ::String

The instance ID.

Parameters = ::Dict{String,String}

The parameters for the documents runtime configuration.

Targets = [[ ... ], ...]

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

 Targets = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

ScheduleExpression = ::String

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

OutputLocation = ["S3Location" => [ ... ]]

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

 OutputLocation = ["S3Location" =>  [
            "OutputS3Region" =>  ::String,
            "OutputS3BucketName" =>  ::String,
            "OutputS3KeyPrefix" =>  ::String
        ]]

AssociationName = ::String

Specify a descriptive name for the association.

Returns

CreateAssociationResult

Exceptions

AssociationAlreadyExists, AssociationLimitExceeded, InternalServerError, InvalidDocument, InvalidDocumentVersion, InvalidInstanceId, UnsupportedPlatformType, InvalidOutputLocation, InvalidParameters, InvalidTarget or InvalidSchedule.

See also: AWS API Documentation

using AWSSDK.SSM.create_association_batch
create_association_batch([::AWSConfig], arguments::Dict)
create_association_batch([::AWSConfig]; Entries=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "CreateAssociationBatch", arguments::Dict)
ssm([::AWSConfig], "CreateAssociationBatch", Entries=)

CreateAssociationBatch Operation

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

Arguments

Entries = [[ ... ], ...] – Required

One or more associations.

 Entries = [[
        "Name" => <required> ::String,
        "InstanceId" =>  ::String,
        "Parameters" =>  ::Dict{String,String},
        "DocumentVersion" =>  ::String,
        "Targets" =>  [[
            "Key" =>  ::String,
            "Values" =>  [::String, ...]
        ], ...],
        "ScheduleExpression" =>  ::String,
        "OutputLocation" =>  ["S3Location" =>  [
                "OutputS3Region" =>  ::String,
                "OutputS3BucketName" =>  ::String,
                "OutputS3KeyPrefix" =>  ::String
            ]],
        "AssociationName" =>  ::String
    ], ...]

Returns

CreateAssociationBatchResult

Exceptions

InternalServerError, InvalidDocument, InvalidDocumentVersion, InvalidInstanceId, InvalidParameters, DuplicateInstanceId, AssociationLimitExceeded, UnsupportedPlatformType, InvalidOutputLocation, InvalidTarget or InvalidSchedule.

See also: AWS API Documentation

using AWSSDK.SSM.create_document
create_document([::AWSConfig], arguments::Dict)
create_document([::AWSConfig]; Content=, Name=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "CreateDocument", arguments::Dict)
ssm([::AWSConfig], "CreateDocument", Content=, Name=, <keyword arguments>)

CreateDocument Operation

Creates a Systems Manager document.

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

Arguments

Content = ::String – Required

A valid JSON string.

Name = ::String – Required

A name for the Systems Manager document.

DocumentType = "Command", "Policy" or "Automation"

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

Returns

CreateDocumentResult

Exceptions

DocumentAlreadyExists, MaxDocumentSizeExceeded, InternalServerError, InvalidDocumentContent, DocumentLimitExceeded or InvalidDocumentSchemaVersion.

See also: AWS API Documentation

using AWSSDK.SSM.create_maintenance_window
create_maintenance_window([::AWSConfig], arguments::Dict)
create_maintenance_window([::AWSConfig]; Name=, Schedule=, Duration=, Cutoff=, AllowUnassociatedTargets=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "CreateMaintenanceWindow", arguments::Dict)
ssm([::AWSConfig], "CreateMaintenanceWindow", Name=, Schedule=, Duration=, Cutoff=, AllowUnassociatedTargets=, <keyword arguments>)

CreateMaintenanceWindow Operation

Creates a new Maintenance Window.

Arguments

Name = ::String – Required

The name of the Maintenance Window.

Description = ::String

An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows.

Schedule = ::String – Required

The schedule of the Maintenance Window in the form of a cron or rate expression.

Duration = ::Int – Required

The duration of the Maintenance Window in hours.

Cutoff = ::Int – Required

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

AllowUnassociatedTargets = ::Bool – Required

Enables a Maintenance Window task to execute 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 = ::String

User-provided idempotency token.

Returns

CreateMaintenanceWindowResult

Exceptions

IdempotentParameterMismatch, ResourceLimitExceededException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.create_patch_baseline
create_patch_baseline([::AWSConfig], arguments::Dict)
create_patch_baseline([::AWSConfig]; Name=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "CreatePatchBaseline", arguments::Dict)
ssm([::AWSConfig], "CreatePatchBaseline", Name=, <keyword arguments>)

CreatePatchBaseline Operation

Creates a patch baseline.

Arguments

OperatingSystem = "WINDOWS", "AMAZON_LINUX", "UBUNTU" or "REDHAT_ENTERPRISE_LINUX"

Defines the operating system the patch baseline applies to. Supported operating systems include WINDOWS, AMAZON_LINUX, UBUNTU and REDHAT_ENTERPRISE_LINUX. The Default value is WINDOWS.

Name = ::String – Required

The name of the patch baseline.

GlobalFilters = ["PatchFilters" => <required> [[ ... ], ...]]

A set of global filters used to exclude patches from the baseline.

 GlobalFilters = ["PatchFilters" => <required> [[
            "Key" => <required> "PRODUCT", "CLASSIFICATION", "MSRC_SEVERITY", "PATCH_ID", "SECTION", "PRIORITY" or "SEVERITY",
            "Values" => <required> [::String, ...]
        ], ...]]

ApprovalRules = ["PatchRules" => <required> [[ ... ], ...]]

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

 ApprovalRules = ["PatchRules" => <required> [[
            "PatchFilterGroup" => <required> ["PatchFilters" => <required> [[
                    "Key" => <required> "PRODUCT", "CLASSIFICATION", "MSRC_SEVERITY", "PATCH_ID", "SECTION", "PRIORITY" or "SEVERITY",
                    "Values" => <required> [::String, ...]
                ], ...]],
            "ComplianceLevel" =>  "CRITICAL", "HIGH", "MEDIUM", "LOW", "INFORMATIONAL" or "UNSPECIFIED",
            "ApproveAfterDays" => <required> ::Int
        ], ...]]

ApprovedPatches = [::String, ...]

A list of explicitly approved patches for the baseline.

ApprovedPatchesComplianceLevel = "CRITICAL", "HIGH", "MEDIUM", "LOW", "INFORMATIONAL" or "UNSPECIFIED"

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. Valid compliance severity levels include the following: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED. The default value is UNSPECIFIED.

RejectedPatches = [::String, ...]

A list of explicitly rejected patches for the baseline.

Description = ::String

A description of the patch baseline.

ClientToken = ::String

User-provided idempotency token.

Returns

CreatePatchBaselineResult

Exceptions

IdempotentParameterMismatch, ResourceLimitExceededException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.create_resource_data_sync
create_resource_data_sync([::AWSConfig], arguments::Dict)
create_resource_data_sync([::AWSConfig]; SyncName=, S3Destination=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "CreateResourceDataSync", arguments::Dict)
ssm([::AWSConfig], "CreateResourceDataSync", SyncName=, S3Destination=)

CreateResourceDataSync Operation

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

By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.

Arguments

SyncName = ::String – Required

A name for the configuration.

S3Destination = [ ... ] – Required

Amazon S3 configuration details for the sync.

 S3Destination = [
        "BucketName" => <required> ::String,
        "Prefix" =>  ::String,
        "SyncFormat" => <required> "JsonSerDe",
        "Region" => <required> ::String,
        "AWSKMSKeyARN" =>  ::String
    ]

Returns

CreateResourceDataSyncResult

Exceptions

InternalServerError, ResourceDataSyncCountExceededException, ResourceDataSyncAlreadyExistsException or ResourceDataSyncInvalidConfigurationException.

See also: AWS API Documentation

using AWSSDK.SSM.delete_activation
delete_activation([::AWSConfig], arguments::Dict)
delete_activation([::AWSConfig]; ActivationId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeleteActivation", arguments::Dict)
ssm([::AWSConfig], "DeleteActivation", ActivationId=)

DeleteActivation Operation

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.

Arguments

ActivationId = ::String – Required

The ID of the activation that you want to delete.

Returns

DeleteActivationResult

Exceptions

InvalidActivationId, InvalidActivation, InternalServerError or TooManyUpdates.

See also: AWS API Documentation

using AWSSDK.SSM.delete_association
delete_association([::AWSConfig], arguments::Dict)
delete_association([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeleteAssociation", arguments::Dict)
ssm([::AWSConfig], "DeleteAssociation", <keyword arguments>)

DeleteAssociation Operation

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.

Arguments

Name = ::String

The name of the Systems Manager document.

InstanceId = ::String

The ID of the instance.

AssociationId = ::String

The association ID that you want to delete.

Returns

DeleteAssociationResult

Exceptions

AssociationDoesNotExist, InternalServerError, InvalidDocument, InvalidInstanceId or TooManyUpdates.

See also: AWS API Documentation

using AWSSDK.SSM.delete_document
delete_document([::AWSConfig], arguments::Dict)
delete_document([::AWSConfig]; Name=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeleteDocument", arguments::Dict)
ssm([::AWSConfig], "DeleteDocument", Name=)

DeleteDocument Operation

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.

Arguments

Name = ::String – Required

The name of the document.

Returns

DeleteDocumentResult

Exceptions

InternalServerError, InvalidDocument, InvalidDocumentOperation or AssociatedInstances.

See also: AWS API Documentation

using AWSSDK.SSM.delete_maintenance_window
delete_maintenance_window([::AWSConfig], arguments::Dict)
delete_maintenance_window([::AWSConfig]; WindowId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeleteMaintenanceWindow", arguments::Dict)
ssm([::AWSConfig], "DeleteMaintenanceWindow", WindowId=)

DeleteMaintenanceWindow Operation

Deletes a Maintenance Window.

Arguments

WindowId = ::String – Required

The ID of the Maintenance Window to delete.

Returns

DeleteMaintenanceWindowResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.delete_parameter
delete_parameter([::AWSConfig], arguments::Dict)
delete_parameter([::AWSConfig]; Name=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeleteParameter", arguments::Dict)
ssm([::AWSConfig], "DeleteParameter", Name=)

DeleteParameter Operation

Delete a parameter from the system.

Arguments

Name = ::String – Required

The name of the parameter to delete.

Returns

DeleteParameterResult

Exceptions

InternalServerError or ParameterNotFound.

See also: AWS API Documentation

using AWSSDK.SSM.delete_parameters
delete_parameters([::AWSConfig], arguments::Dict)
delete_parameters([::AWSConfig]; Names=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeleteParameters", arguments::Dict)
ssm([::AWSConfig], "DeleteParameters", Names=)

DeleteParameters Operation

Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.

Arguments

Names = [::String, ...] – Required

The names of the parameters to delete.

Returns

DeleteParametersResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.delete_patch_baseline
delete_patch_baseline([::AWSConfig], arguments::Dict)
delete_patch_baseline([::AWSConfig]; BaselineId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeletePatchBaseline", arguments::Dict)
ssm([::AWSConfig], "DeletePatchBaseline", BaselineId=)

DeletePatchBaseline Operation

Deletes a patch baseline.

Arguments

BaselineId = ::String – Required

The ID of the patch baseline to delete.

Returns

DeletePatchBaselineResult

Exceptions

ResourceInUseException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.delete_resource_data_sync
delete_resource_data_sync([::AWSConfig], arguments::Dict)
delete_resource_data_sync([::AWSConfig]; SyncName=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeleteResourceDataSync", arguments::Dict)
ssm([::AWSConfig], "DeleteResourceDataSync", SyncName=)

DeleteResourceDataSync Operation

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.

Arguments

SyncName = ::String – Required

The name of the configuration to delete.

Returns

DeleteResourceDataSyncResult

Exceptions

InternalServerError or ResourceDataSyncNotFoundException.

See also: AWS API Documentation

using AWSSDK.SSM.deregister_managed_instance
deregister_managed_instance([::AWSConfig], arguments::Dict)
deregister_managed_instance([::AWSConfig]; InstanceId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeregisterManagedInstance", arguments::Dict)
ssm([::AWSConfig], "DeregisterManagedInstance", InstanceId=)

DeregisterManagedInstance Operation

Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling the SSM Agent first.

Arguments

InstanceId = ::String – Required

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

Returns

DeregisterManagedInstanceResult

Exceptions

InvalidInstanceId or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.deregister_patch_baseline_for_patch_group
deregister_patch_baseline_for_patch_group([::AWSConfig], arguments::Dict)
deregister_patch_baseline_for_patch_group([::AWSConfig]; BaselineId=, PatchGroup=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeregisterPatchBaselineForPatchGroup", arguments::Dict)
ssm([::AWSConfig], "DeregisterPatchBaselineForPatchGroup", BaselineId=, PatchGroup=)

DeregisterPatchBaselineForPatchGroup Operation

Removes a patch group from a patch baseline.

Arguments

BaselineId = ::String – Required

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

PatchGroup = ::String – Required

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

Returns

DeregisterPatchBaselineForPatchGroupResult

Exceptions

InvalidResourceId or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.deregister_target_from_maintenance_window
deregister_target_from_maintenance_window([::AWSConfig], arguments::Dict)
deregister_target_from_maintenance_window([::AWSConfig]; WindowId=, WindowTargetId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeregisterTargetFromMaintenanceWindow", arguments::Dict)
ssm([::AWSConfig], "DeregisterTargetFromMaintenanceWindow", WindowId=, WindowTargetId=, <keyword arguments>)

DeregisterTargetFromMaintenanceWindow Operation

Removes a target from a Maintenance Window.

Arguments

WindowId = ::String – Required

The ID of the Maintenance Window the target should be removed from.

WindowTargetId = ::String – Required

The ID of the target definition to remove.

Safe = ::Bool

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.

Returns

DeregisterTargetFromMaintenanceWindowResult

Exceptions

DoesNotExistException, InternalServerError or TargetInUseException.

See also: AWS API Documentation

using AWSSDK.SSM.deregister_task_from_maintenance_window
deregister_task_from_maintenance_window([::AWSConfig], arguments::Dict)
deregister_task_from_maintenance_window([::AWSConfig]; WindowId=, WindowTaskId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DeregisterTaskFromMaintenanceWindow", arguments::Dict)
ssm([::AWSConfig], "DeregisterTaskFromMaintenanceWindow", WindowId=, WindowTaskId=)

DeregisterTaskFromMaintenanceWindow Operation

Removes a task from a Maintenance Window.

Arguments

WindowId = ::String – Required

The ID of the Maintenance Window the task should be removed from.

WindowTaskId = ::String – Required

The ID of the task to remove from the Maintenance Window.

Returns

DeregisterTaskFromMaintenanceWindowResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_activations
describe_activations([::AWSConfig], arguments::Dict)
describe_activations([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeActivations", arguments::Dict)
ssm([::AWSConfig], "DescribeActivations", <keyword arguments>)

DescribeActivations Operation

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.

Arguments

Filters = [[ ... ], ...]

A filter to view information about your activations.

 Filters = [[
        "FilterKey" =>  "ActivationIds", "DefaultInstanceName" or "IamRole",
        "FilterValues" =>  [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeActivationsResult

Exceptions

InvalidFilter, InvalidNextToken or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_association
describe_association([::AWSConfig], arguments::Dict)
describe_association([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeAssociation", arguments::Dict)
ssm([::AWSConfig], "DescribeAssociation", <keyword arguments>)

DescribeAssociation Operation

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

Arguments

Name = ::String

The name of the Systems Manager document.

InstanceId = ::String

The instance ID.

AssociationId = ::String

The association ID for which you want information.

AssociationVersion = ::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 ListInstanceAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

Returns

DescribeAssociationResult

Exceptions

AssociationDoesNotExist, InvalidAssociationVersion, InternalServerError, InvalidDocument or InvalidInstanceId.

See also: AWS API Documentation

using AWSSDK.SSM.describe_automation_executions
describe_automation_executions([::AWSConfig], arguments::Dict)
describe_automation_executions([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeAutomationExecutions", arguments::Dict)
ssm([::AWSConfig], "DescribeAutomationExecutions", <keyword arguments>)

DescribeAutomationExecutions Operation

Provides details about all active and terminated Automation executions.

Arguments

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" => <required> "DocumentNamePrefix" or "ExecutionStatus",
        "Values" => <required> [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeAutomationExecutionsResult

Exceptions

InvalidNextToken or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_available_patches
describe_available_patches([::AWSConfig], arguments::Dict)
describe_available_patches([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeAvailablePatches", arguments::Dict)
ssm([::AWSConfig], "DescribeAvailablePatches", <keyword arguments>)

DescribeAvailablePatches Operation

Lists all patches that could possibly be included in a patch baseline.

Arguments

Filters = [[ ... ], ...]

Filters used to scope down the returned patches.

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::Int

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

NextToken = ::String

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

Returns

DescribeAvailablePatchesResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_document
describe_document([::AWSConfig], arguments::Dict)
describe_document([::AWSConfig]; Name=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeDocument", arguments::Dict)
ssm([::AWSConfig], "DescribeDocument", Name=, <keyword arguments>)

DescribeDocument Operation

Describes the specified Systems Manager document.

Arguments

Name = ::String – Required

The name of the Systems Manager document.

DocumentVersion = ::String

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

Returns

DescribeDocumentResult

Exceptions

InternalServerError, InvalidDocument or InvalidDocumentVersion.

See also: AWS API Documentation

using AWSSDK.SSM.describe_document_permission
describe_document_permission([::AWSConfig], arguments::Dict)
describe_document_permission([::AWSConfig]; Name=, PermissionType=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeDocumentPermission", arguments::Dict)
ssm([::AWSConfig], "DescribeDocumentPermission", Name=, PermissionType=)

DescribeDocumentPermission Operation

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

Arguments

Name = ::String – Required

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

PermissionType = "Share" – Required

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

Returns

DescribeDocumentPermissionResponse

Exceptions

InternalServerError, InvalidDocument or InvalidPermissionType.

See also: AWS API Documentation

using AWSSDK.SSM.describe_effective_instance_associations
describe_effective_instance_associations([::AWSConfig], arguments::Dict)
describe_effective_instance_associations([::AWSConfig]; InstanceId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeEffectiveInstanceAssociations", arguments::Dict)
ssm([::AWSConfig], "DescribeEffectiveInstanceAssociations", InstanceId=, <keyword arguments>)

DescribeEffectiveInstanceAssociations Operation

All associations for the instance(s).

Arguments

InstanceId = ::String – Required

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

MaxResults = ::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 = ::String

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

Returns

DescribeEffectiveInstanceAssociationsResult

Exceptions

InternalServerError, InvalidInstanceId or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.describe_effective_patches_for_patch_baseline
describe_effective_patches_for_patch_baseline([::AWSConfig], arguments::Dict)
describe_effective_patches_for_patch_baseline([::AWSConfig]; BaselineId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeEffectivePatchesForPatchBaseline", arguments::Dict)
ssm([::AWSConfig], "DescribeEffectivePatchesForPatchBaseline", BaselineId=, <keyword arguments>)

DescribeEffectivePatchesForPatchBaseline Operation

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.

Arguments

BaselineId = ::String – Required

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

MaxResults = ::Int

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

NextToken = ::String

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

Returns

DescribeEffectivePatchesForPatchBaselineResult

Exceptions

InvalidResourceId, DoesNotExistException, UnsupportedOperatingSystem or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_instance_associations_status
describe_instance_associations_status([::AWSConfig], arguments::Dict)
describe_instance_associations_status([::AWSConfig]; InstanceId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeInstanceAssociationsStatus", arguments::Dict)
ssm([::AWSConfig], "DescribeInstanceAssociationsStatus", InstanceId=, <keyword arguments>)

DescribeInstanceAssociationsStatus Operation

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

Arguments

InstanceId = ::String – Required

The instance IDs for which you want association status information.

MaxResults = ::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 = ::String

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

Returns

DescribeInstanceAssociationsStatusResult

Exceptions

InternalServerError, InvalidInstanceId or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.describe_instance_information
describe_instance_information([::AWSConfig], arguments::Dict)
describe_instance_information([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeInstanceInformation", arguments::Dict)
ssm([::AWSConfig], "DescribeInstanceInformation", <keyword arguments>)

DescribeInstanceInformation Operation

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.

Arguments

InstanceInformationFilterList = [[ ... ], ...]

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

 InstanceInformationFilterList = [[
        "key" => <required> "InstanceIds", "AgentVersion", "PingStatus", "PlatformTypes", "ActivationIds", "IamRole", "ResourceType" or "AssociationStatus",
        "valueSet" => <required> [::String, ...]
    ], ...]

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" => <required> ::String,
        "Values" => <required> [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeInstanceInformationResult

Exceptions

InternalServerError, InvalidInstanceId, InvalidNextToken, InvalidInstanceInformationFilterValue or InvalidFilterKey.

See also: AWS API Documentation

using AWSSDK.SSM.describe_instance_patch_states
describe_instance_patch_states([::AWSConfig], arguments::Dict)
describe_instance_patch_states([::AWSConfig]; InstanceIds=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeInstancePatchStates", arguments::Dict)
ssm([::AWSConfig], "DescribeInstancePatchStates", InstanceIds=, <keyword arguments>)

DescribeInstancePatchStates Operation

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

Arguments

InstanceIds = [::String, ...] – Required

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

NextToken = ::String

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

MaxResults = ::Int

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

Returns

DescribeInstancePatchStatesResult

Exceptions

InternalServerError or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.describe_instance_patch_states_for_patch_group
describe_instance_patch_states_for_patch_group([::AWSConfig], arguments::Dict)
describe_instance_patch_states_for_patch_group([::AWSConfig]; PatchGroup=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeInstancePatchStatesForPatchGroup", arguments::Dict)
ssm([::AWSConfig], "DescribeInstancePatchStatesForPatchGroup", PatchGroup=, <keyword arguments>)

DescribeInstancePatchStatesForPatchGroup Operation

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

Arguments

PatchGroup = ::String – Required

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

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" => <required> ::String,
        "Values" => <required> [::String, ...],
        "Type" => <required> "Equal", "NotEqual", "LessThan" or "GreaterThan"
    ], ...]

NextToken = ::String

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

MaxResults = ::Int

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

Returns

DescribeInstancePatchStatesForPatchGroupResult

Exceptions

InternalServerError, InvalidFilter or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.describe_instance_patches
describe_instance_patches([::AWSConfig], arguments::Dict)
describe_instance_patches([::AWSConfig]; InstanceId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeInstancePatches", arguments::Dict)
ssm([::AWSConfig], "DescribeInstancePatches", InstanceId=, <keyword arguments>)

DescribeInstancePatches Operation

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

Arguments

InstanceId = ::String – Required

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

Filters = [[ ... ], ...]

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)

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

NextToken = ::String

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

MaxResults = ::Int

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

Returns

DescribeInstancePatchesResult

Exceptions

InternalServerError, InvalidInstanceId, InvalidFilter or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.describe_maintenance_window_execution_task_invocations
describe_maintenance_window_execution_task_invocations([::AWSConfig], arguments::Dict)
describe_maintenance_window_execution_task_invocations([::AWSConfig]; WindowExecutionId=, TaskId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeMaintenanceWindowExecutionTaskInvocations", arguments::Dict)
ssm([::AWSConfig], "DescribeMaintenanceWindowExecutionTaskInvocations", WindowExecutionId=, TaskId=, <keyword arguments>)

DescribeMaintenanceWindowExecutionTaskInvocations Operation

Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.

Arguments

WindowExecutionId = ::String – Required

The ID of the Maintenance Window execution the task is part of.

TaskId = ::String – Required

The ID of the specific task in the Maintenance Window task that should be retrieved.

Filters = [[ ... ], ...]

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.

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeMaintenanceWindowExecutionTaskInvocationsResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_maintenance_window_execution_tasks
describe_maintenance_window_execution_tasks([::AWSConfig], arguments::Dict)
describe_maintenance_window_execution_tasks([::AWSConfig]; WindowExecutionId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeMaintenanceWindowExecutionTasks", arguments::Dict)
ssm([::AWSConfig], "DescribeMaintenanceWindowExecutionTasks", WindowExecutionId=, <keyword arguments>)

DescribeMaintenanceWindowExecutionTasks Operation

For a given Maintenance Window execution, lists the tasks that were executed.

Arguments

WindowExecutionId = ::String – Required

The ID of the Maintenance Window execution whose task executions should be retrieved.

Filters = [[ ... ], ...]

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.

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeMaintenanceWindowExecutionTasksResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_maintenance_window_executions
describe_maintenance_window_executions([::AWSConfig], arguments::Dict)
describe_maintenance_window_executions([::AWSConfig]; WindowId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeMaintenanceWindowExecutions", arguments::Dict)
ssm([::AWSConfig], "DescribeMaintenanceWindowExecutions", WindowId=, <keyword arguments>)

DescribeMaintenanceWindowExecutions Operation

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.

Arguments

WindowId = ::String – Required

The ID of the Maintenance Window whose executions should be retrieved.

Filters = [[ ... ], ...]

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.

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeMaintenanceWindowExecutionsResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_maintenance_window_targets
describe_maintenance_window_targets([::AWSConfig], arguments::Dict)
describe_maintenance_window_targets([::AWSConfig]; WindowId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeMaintenanceWindowTargets", arguments::Dict)
ssm([::AWSConfig], "DescribeMaintenanceWindowTargets", WindowId=, <keyword arguments>)

DescribeMaintenanceWindowTargets Operation

Lists the targets registered with the Maintenance Window.

Arguments

WindowId = ::String – Required

The ID of the Maintenance Window whose targets should be retrieved.

Filters = [[ ... ], ...]

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.

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeMaintenanceWindowTargetsResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_maintenance_window_tasks
describe_maintenance_window_tasks([::AWSConfig], arguments::Dict)
describe_maintenance_window_tasks([::AWSConfig]; WindowId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeMaintenanceWindowTasks", arguments::Dict)
ssm([::AWSConfig], "DescribeMaintenanceWindowTasks", WindowId=, <keyword arguments>)

DescribeMaintenanceWindowTasks Operation

Lists the tasks in a Maintenance Window.

Arguments

WindowId = ::String – Required

The ID of the Maintenance Window whose tasks should be retrieved.

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeMaintenanceWindowTasksResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_maintenance_windows
describe_maintenance_windows([::AWSConfig], arguments::Dict)
describe_maintenance_windows([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeMaintenanceWindows", arguments::Dict)
ssm([::AWSConfig], "DescribeMaintenanceWindows", <keyword arguments>)

DescribeMaintenanceWindows Operation

Retrieves the Maintenance Windows in an AWS account.

Arguments

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeMaintenanceWindowsResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_parameters
describe_parameters([::AWSConfig], arguments::Dict)
describe_parameters([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribeParameters", arguments::Dict)
ssm([::AWSConfig], "DescribeParameters", <keyword arguments>)

DescribeParameters Operation

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.

Arguments

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" => <required> "Name", "Type" or "KeyId",
        "Values" => <required> [::String, ...]
    ], ...]

ParameterFilters = [[ ... ], ...]

Filters to limit the request results.

 ParameterFilters = [[
        "Key" => <required> ::String,
        "Option" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

DescribeParametersResult

Exceptions

InternalServerError, InvalidFilterKey, InvalidFilterOption, InvalidFilterValue or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.describe_patch_baselines
describe_patch_baselines([::AWSConfig], arguments::Dict)
describe_patch_baselines([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribePatchBaselines", arguments::Dict)
ssm([::AWSConfig], "DescribePatchBaselines", <keyword arguments>)

DescribePatchBaselines Operation

Lists the patch baselines in your AWS account.

Arguments

Filters = [[ ... ], ...]

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)

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::Int

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

NextToken = ::String

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

Returns

DescribePatchBaselinesResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.describe_patch_group_state
describe_patch_group_state([::AWSConfig], arguments::Dict)
describe_patch_group_state([::AWSConfig]; PatchGroup=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribePatchGroupState", arguments::Dict)
ssm([::AWSConfig], "DescribePatchGroupState", PatchGroup=)

DescribePatchGroupState Operation

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

Arguments

PatchGroup = ::String – Required

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

Returns

DescribePatchGroupStateResult

Exceptions

InternalServerError or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.describe_patch_groups
describe_patch_groups([::AWSConfig], arguments::Dict)
describe_patch_groups([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "DescribePatchGroups", arguments::Dict)
ssm([::AWSConfig], "DescribePatchGroups", <keyword arguments>)

DescribePatchGroups Operation

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

Arguments

MaxResults = ::Int

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

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

NextToken = ::String

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

Returns

DescribePatchGroupsResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_automation_execution
get_automation_execution([::AWSConfig], arguments::Dict)
get_automation_execution([::AWSConfig]; AutomationExecutionId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetAutomationExecution", arguments::Dict)
ssm([::AWSConfig], "GetAutomationExecution", AutomationExecutionId=)

GetAutomationExecution Operation

Get detailed information about a particular Automation execution.

Arguments

AutomationExecutionId = ::String – Required

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.

Returns

GetAutomationExecutionResult

Exceptions

AutomationExecutionNotFoundException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_command_invocation
get_command_invocation([::AWSConfig], arguments::Dict)
get_command_invocation([::AWSConfig]; CommandId=, InstanceId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetCommandInvocation", arguments::Dict)
ssm([::AWSConfig], "GetCommandInvocation", CommandId=, InstanceId=, <keyword arguments>)

GetCommandInvocation Operation

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

Arguments

CommandId = ::String – Required

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

InstanceId = ::String – Required

(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 = ::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.

Returns

GetCommandInvocationResult

Exceptions

InternalServerError, InvalidCommandId, InvalidInstanceId, InvalidPluginName or InvocationDoesNotExist.

See also: AWS API Documentation

using AWSSDK.SSM.get_default_patch_baseline
get_default_patch_baseline([::AWSConfig], arguments::Dict)
get_default_patch_baseline([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetDefaultPatchBaseline", arguments::Dict)
ssm([::AWSConfig], "GetDefaultPatchBaseline", <keyword arguments>)

GetDefaultPatchBaseline Operation

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.

Arguments

OperatingSystem = "WINDOWS", "AMAZON_LINUX", "UBUNTU" or "REDHAT_ENTERPRISE_LINUX"

Returns the default patch baseline for the specified operating system.

Returns

GetDefaultPatchBaselineResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_deployable_patch_snapshot_for_instance
get_deployable_patch_snapshot_for_instance([::AWSConfig], arguments::Dict)
get_deployable_patch_snapshot_for_instance([::AWSConfig]; InstanceId=, SnapshotId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetDeployablePatchSnapshotForInstance", arguments::Dict)
ssm([::AWSConfig], "GetDeployablePatchSnapshotForInstance", InstanceId=, SnapshotId=)

GetDeployablePatchSnapshotForInstance Operation

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

Arguments

InstanceId = ::String – Required

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

SnapshotId = ::String – Required

The user-defined snapshot ID.

Returns

GetDeployablePatchSnapshotForInstanceResult

Exceptions

InternalServerError or UnsupportedOperatingSystem.

See also: AWS API Documentation

using AWSSDK.SSM.get_document
get_document([::AWSConfig], arguments::Dict)
get_document([::AWSConfig]; Name=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetDocument", arguments::Dict)
ssm([::AWSConfig], "GetDocument", Name=, <keyword arguments>)

GetDocument Operation

Gets the contents of the specified Systems Manager document.

Arguments

Name = ::String – Required

The name of the Systems Manager document.

DocumentVersion = ::String

The document version for which you want information.

Returns

GetDocumentResult

Exceptions

InternalServerError, InvalidDocument or InvalidDocumentVersion.

See also: AWS API Documentation

using AWSSDK.SSM.get_inventory
get_inventory([::AWSConfig], arguments::Dict)
get_inventory([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetInventory", arguments::Dict)
ssm([::AWSConfig], "GetInventory", <keyword arguments>)

GetInventory Operation

Query inventory information.

Arguments

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" => <required> ::String,
        "Values" => <required> [::String, ...],
        "Type" =>  "Equal", "NotEqual", "BeginWith", "LessThan" or "GreaterThan"
    ], ...]

ResultAttributes = [["TypeName" => <required> ::String], ...]

The list of inventory item types to return.

NextToken = ::String

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

MaxResults = ::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.

Returns

GetInventoryResult

Exceptions

InternalServerError, InvalidFilter, InvalidNextToken, InvalidTypeNameException or InvalidResultAttributeException.

See also: AWS API Documentation

using AWSSDK.SSM.get_inventory_schema
get_inventory_schema([::AWSConfig], arguments::Dict)
get_inventory_schema([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetInventorySchema", arguments::Dict)
ssm([::AWSConfig], "GetInventorySchema", <keyword arguments>)

GetInventorySchema Operation

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

Arguments

TypeName = ::String

The type of inventory item to return.

NextToken = ::String

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

MaxResults = ::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.

SubType = ::Bool

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

Returns

GetInventorySchemaResult

Exceptions

InternalServerError, InvalidTypeNameException or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.get_maintenance_window
get_maintenance_window([::AWSConfig], arguments::Dict)
get_maintenance_window([::AWSConfig]; WindowId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetMaintenanceWindow", arguments::Dict)
ssm([::AWSConfig], "GetMaintenanceWindow", WindowId=)

GetMaintenanceWindow Operation

Retrieves a Maintenance Window.

Arguments

WindowId = ::String – Required

The ID of the desired Maintenance Window.

Returns

GetMaintenanceWindowResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_maintenance_window_execution
get_maintenance_window_execution([::AWSConfig], arguments::Dict)
get_maintenance_window_execution([::AWSConfig]; WindowExecutionId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetMaintenanceWindowExecution", arguments::Dict)
ssm([::AWSConfig], "GetMaintenanceWindowExecution", WindowExecutionId=)

GetMaintenanceWindowExecution Operation

Retrieves details about a specific task executed as part of a Maintenance Window execution.

Arguments

WindowExecutionId = ::String – Required

The ID of the Maintenance Window execution that includes the task.

Returns

GetMaintenanceWindowExecutionResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_maintenance_window_execution_task
get_maintenance_window_execution_task([::AWSConfig], arguments::Dict)
get_maintenance_window_execution_task([::AWSConfig]; WindowExecutionId=, TaskId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetMaintenanceWindowExecutionTask", arguments::Dict)
ssm([::AWSConfig], "GetMaintenanceWindowExecutionTask", WindowExecutionId=, TaskId=)

GetMaintenanceWindowExecutionTask Operation

Retrieves the details about a specific task executed as part of a Maintenance Window execution.

Arguments

WindowExecutionId = ::String – Required

The ID of the Maintenance Window execution that includes the task.

TaskId = ::String – Required

The ID of the specific task execution in the Maintenance Window task that should be retrieved.

Returns

GetMaintenanceWindowExecutionTaskResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_maintenance_window_execution_task_invocation
get_maintenance_window_execution_task_invocation([::AWSConfig], arguments::Dict)
get_maintenance_window_execution_task_invocation([::AWSConfig]; WindowExecutionId=, TaskId=, InvocationId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetMaintenanceWindowExecutionTaskInvocation", arguments::Dict)
ssm([::AWSConfig], "GetMaintenanceWindowExecutionTaskInvocation", WindowExecutionId=, TaskId=, InvocationId=)

GetMaintenanceWindowExecutionTaskInvocation Operation

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

Arguments

WindowExecutionId = ::String – Required

The ID of the Maintenance Window execution for which the task is a part.

TaskId = ::String – Required

The ID of the specific task in the Maintenance Window task that should be retrieved.

InvocationId = ::String – Required

The invocation ID to retrieve.

Returns

GetMaintenanceWindowExecutionTaskInvocationResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_maintenance_window_task
get_maintenance_window_task([::AWSConfig], arguments::Dict)
get_maintenance_window_task([::AWSConfig]; WindowId=, WindowTaskId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetMaintenanceWindowTask", arguments::Dict)
ssm([::AWSConfig], "GetMaintenanceWindowTask", WindowId=, WindowTaskId=)

GetMaintenanceWindowTask Operation

Lists the tasks in a Maintenance Window.

Arguments

WindowId = ::String – Required

The Maintenance Window ID that includes the task to retrieve.

WindowTaskId = ::String – Required

The Maintenance Window task ID to retrieve.

Returns

GetMaintenanceWindowTaskResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_parameter
get_parameter([::AWSConfig], arguments::Dict)
get_parameter([::AWSConfig]; Name=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetParameter", arguments::Dict)
ssm([::AWSConfig], "GetParameter", Name=, <keyword arguments>)

GetParameter Operation

Get information about a parameter by using the parameter name.

Arguments

Name = ::String – Required

The name of the parameter you want to query.

WithDecryption = ::Bool

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

Returns

GetParameterResult

Exceptions

InternalServerError, InvalidKeyId, ParameterNotFound or ParameterVersionNotFound.

See also: AWS API Documentation

using AWSSDK.SSM.get_parameter_history
get_parameter_history([::AWSConfig], arguments::Dict)
get_parameter_history([::AWSConfig]; Name=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetParameterHistory", arguments::Dict)
ssm([::AWSConfig], "GetParameterHistory", Name=, <keyword arguments>)

GetParameterHistory Operation

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

Arguments

Name = ::String – Required

The name of a parameter you want to query.

WithDecryption = ::Bool

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

MaxResults = ::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 = ::String

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

Returns

GetParameterHistoryResult

Exceptions

InternalServerError, ParameterNotFound, InvalidNextToken or InvalidKeyId.

See also: AWS API Documentation

using AWSSDK.SSM.get_parameters
get_parameters([::AWSConfig], arguments::Dict)
get_parameters([::AWSConfig]; Names=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetParameters", arguments::Dict)
ssm([::AWSConfig], "GetParameters", Names=, <keyword arguments>)

GetParameters Operation

Get details of a parameter.

Arguments

Names = [::String, ...] – Required

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

WithDecryption = ::Bool

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

Returns

GetParametersResult

Exceptions

InvalidKeyId or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_parameters_by_path
get_parameters_by_path([::AWSConfig], arguments::Dict)
get_parameters_by_path([::AWSConfig]; Path=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetParametersByPath", arguments::Dict)
ssm([::AWSConfig], "GetParametersByPath", Path=, <keyword arguments>)

GetParametersByPath Operation

Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters.

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.

Arguments

Path = ::String – Required

The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A hierarchy can have a maximum of five levels. Examples: /Environment/Test/DBString003

/Finance/Prod/IAD/OS/WinServ2016/license15

Recursive = ::Bool

Retrieve all parameters within a hierarchy.

ParameterFilters = [[ ... ], ...]

Filters to limit the request results.

 ParameterFilters = [[
        "Key" => <required> ::String,
        "Option" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

WithDecryption = ::Bool

Retrieve all parameters in a hierarchy with their value decrypted.

MaxResults = ::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 = ::String

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

Returns

GetParametersByPathResult

Exceptions

InternalServerError, InvalidFilterKey, InvalidFilterOption, InvalidFilterValue, InvalidKeyId or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.get_patch_baseline
get_patch_baseline([::AWSConfig], arguments::Dict)
get_patch_baseline([::AWSConfig]; BaselineId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetPatchBaseline", arguments::Dict)
ssm([::AWSConfig], "GetPatchBaseline", BaselineId=)

GetPatchBaseline Operation

Retrieves information about a patch baseline.

Arguments

BaselineId = ::String – Required

The ID of the patch baseline to retrieve.

Returns

GetPatchBaselineResult

Exceptions

DoesNotExistException, InvalidResourceId or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.get_patch_baseline_for_patch_group
get_patch_baseline_for_patch_group([::AWSConfig], arguments::Dict)
get_patch_baseline_for_patch_group([::AWSConfig]; PatchGroup=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "GetPatchBaselineForPatchGroup", arguments::Dict)
ssm([::AWSConfig], "GetPatchBaselineForPatchGroup", PatchGroup=, <keyword arguments>)

GetPatchBaselineForPatchGroup Operation

Retrieves the patch baseline that should be used for the specified patch group.

Arguments

PatchGroup = ::String – Required

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

OperatingSystem = "WINDOWS", "AMAZON_LINUX", "UBUNTU" or "REDHAT_ENTERPRISE_LINUX"

Returns he operating system rule specified for patch groups using the patch baseline.

Returns

GetPatchBaselineForPatchGroupResult

Exceptions

InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.list_association_versions
list_association_versions([::AWSConfig], arguments::Dict)
list_association_versions([::AWSConfig]; AssociationId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListAssociationVersions", arguments::Dict)
ssm([::AWSConfig], "ListAssociationVersions", AssociationId=, <keyword arguments>)

ListAssociationVersions Operation

Retrieves all versions of an association for a specific association ID.

Arguments

AssociationId = ::String – Required

The association ID for which you want to view all versions.

MaxResults = ::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 = ::String

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

Returns

ListAssociationVersionsResult

Exceptions

InternalServerError, InvalidNextToken or AssociationDoesNotExist.

See also: AWS API Documentation

using AWSSDK.SSM.list_associations
list_associations([::AWSConfig], arguments::Dict)
list_associations([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListAssociations", arguments::Dict)
ssm([::AWSConfig], "ListAssociations", <keyword arguments>)

ListAssociations Operation

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

Arguments

AssociationFilterList = [[ ... ], ...]

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

 AssociationFilterList = [[
        "key" => <required> "InstanceId", "Name", "AssociationId", "AssociationStatusName", "LastExecutedBefore", "LastExecutedAfter" or "AssociationName",
        "value" => <required> ::String
    ], ...]

MaxResults = ::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 = ::String

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

Returns

ListAssociationsResult

Exceptions

InternalServerError or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.list_command_invocations
list_command_invocations([::AWSConfig], arguments::Dict)
list_command_invocations([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListCommandInvocations", arguments::Dict)
ssm([::AWSConfig], "ListCommandInvocations", <keyword arguments>)

ListCommandInvocations Operation

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

Arguments

CommandId = ::String

(Optional) The invocations for a specific command ID.

InstanceId = ::String

(Optional) The command execution details for a specific instance ID.

MaxResults = ::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 = ::String

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

Filters = [[ ... ], ...]

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

 Filters = [[
        "key" => <required> "InvokedAfter", "InvokedBefore" or "Status",
        "value" => <required> ::String
    ], ...]

Details = ::Bool

(Optional) If set this returns the response of the command executions and any command output. By default this is set to False.

Returns

ListCommandInvocationsResult

Exceptions

InternalServerError, InvalidCommandId, InvalidInstanceId, InvalidFilterKey or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.list_commands
list_commands([::AWSConfig], arguments::Dict)
list_commands([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListCommands", arguments::Dict)
ssm([::AWSConfig], "ListCommands", <keyword arguments>)

ListCommands Operation

Lists the commands requested by users of the AWS account.

Arguments

CommandId = ::String

(Optional) If provided, lists only the specified command.

InstanceId = ::String

(Optional) Lists commands issued against this instance ID.

MaxResults = ::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 = ::String

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

Filters = [[ ... ], ...]

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

 Filters = [[
        "key" => <required> "InvokedAfter", "InvokedBefore" or "Status",
        "value" => <required> ::String
    ], ...]

Returns

ListCommandsResult

Exceptions

InternalServerError, InvalidCommandId, InvalidInstanceId, InvalidFilterKey or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.list_compliance_items
list_compliance_items([::AWSConfig], arguments::Dict)
list_compliance_items([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListComplianceItems", arguments::Dict)
ssm([::AWSConfig], "ListComplianceItems", <keyword arguments>)

ListComplianceItems Operation

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.

Arguments

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...],
        "Type" =>  "EQUAL", "NOT_EQUAL", "BEGIN_WITH", "LESS_THAN" or "GREATER_THAN"
    ], ...]

ResourceIds = [::String, ...]

The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

ResourceTypes = [::String, ...]

The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

NextToken = ::String

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

MaxResults = ::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.

Returns

ListComplianceItemsResult

Exceptions

InvalidResourceType, InvalidResourceId, InternalServerError, InvalidFilter or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.list_compliance_summaries
list_compliance_summaries([::AWSConfig], arguments::Dict)
list_compliance_summaries([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListComplianceSummaries", arguments::Dict)
ssm([::AWSConfig], "ListComplianceSummaries", <keyword arguments>)

ListComplianceSummaries Operation

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.

Arguments

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...],
        "Type" =>  "EQUAL", "NOT_EQUAL", "BEGIN_WITH", "LESS_THAN" or "GREATER_THAN"
    ], ...]

NextToken = ::String

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

MaxResults = ::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.

Returns

ListComplianceSummariesResult

Exceptions

InvalidFilter, InvalidNextToken or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.list_document_versions
list_document_versions([::AWSConfig], arguments::Dict)
list_document_versions([::AWSConfig]; Name=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListDocumentVersions", arguments::Dict)
ssm([::AWSConfig], "ListDocumentVersions", Name=, <keyword arguments>)

ListDocumentVersions Operation

List all versions for a document.

Arguments

Name = ::String – Required

The name of the document about which you want version information.

MaxResults = ::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 = ::String

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

Returns

ListDocumentVersionsResult

Exceptions

InternalServerError, InvalidNextToken or InvalidDocument.

See also: AWS API Documentation

using AWSSDK.SSM.list_documents
list_documents([::AWSConfig], arguments::Dict)
list_documents([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListDocuments", arguments::Dict)
ssm([::AWSConfig], "ListDocuments", <keyword arguments>)

ListDocuments Operation

Describes one or more of your Systems Manager documents.

Arguments

DocumentFilterList = [[ ... ], ...]

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

 DocumentFilterList = [[
        "key" => <required> "Name", "Owner", "PlatformTypes" or "DocumentType",
        "value" => <required> ::String
    ], ...]

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

MaxResults = ::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 = ::String

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

Returns

ListDocumentsResult

Exceptions

InternalServerError, InvalidNextToken or InvalidFilterKey.

See also: AWS API Documentation

using AWSSDK.SSM.list_inventory_entries
list_inventory_entries([::AWSConfig], arguments::Dict)
list_inventory_entries([::AWSConfig]; InstanceId=, TypeName=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListInventoryEntries", arguments::Dict)
ssm([::AWSConfig], "ListInventoryEntries", InstanceId=, TypeName=, <keyword arguments>)

ListInventoryEntries Operation

A list of inventory items returned by the request.

Arguments

InstanceId = ::String – Required

The instance ID for which you want inventory information.

TypeName = ::String – Required

The type of inventory item for which you want information.

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" => <required> ::String,
        "Values" => <required> [::String, ...],
        "Type" =>  "Equal", "NotEqual", "BeginWith", "LessThan" or "GreaterThan"
    ], ...]

NextToken = ::String

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

MaxResults = ::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.

Returns

ListInventoryEntriesResult

Exceptions

InternalServerError, InvalidInstanceId, InvalidTypeNameException, InvalidFilter or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.list_resource_compliance_summaries
list_resource_compliance_summaries([::AWSConfig], arguments::Dict)
list_resource_compliance_summaries([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListResourceComplianceSummaries", arguments::Dict)
ssm([::AWSConfig], "ListResourceComplianceSummaries", <keyword arguments>)

ListResourceComplianceSummaries Operation

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.

Arguments

Filters = [[ ... ], ...]

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

 Filters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...],
        "Type" =>  "EQUAL", "NOT_EQUAL", "BEGIN_WITH", "LESS_THAN" or "GREATER_THAN"
    ], ...]

NextToken = ::String

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

MaxResults = ::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.

Returns

ListResourceComplianceSummariesResult

Exceptions

InvalidFilter, InvalidNextToken or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.list_resource_data_sync
list_resource_data_sync([::AWSConfig], arguments::Dict)
list_resource_data_sync([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListResourceDataSync", arguments::Dict)
ssm([::AWSConfig], "ListResourceDataSync", <keyword arguments>)

ListResourceDataSync Operation

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.

Arguments

NextToken = ::String

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

MaxResults = ::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.

Returns

ListResourceDataSyncResult

Exceptions

InternalServerError or InvalidNextToken.

See also: AWS API Documentation

using AWSSDK.SSM.list_tags_for_resource
list_tags_for_resource([::AWSConfig], arguments::Dict)
list_tags_for_resource([::AWSConfig]; ResourceType=, ResourceId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ListTagsForResource", arguments::Dict)
ssm([::AWSConfig], "ListTagsForResource", ResourceType=, ResourceId=)

ListTagsForResource Operation

Returns a list of the tags assigned to the specified resource.

Arguments

ResourceType = "Document", "ManagedInstance", "MaintenanceWindow", "Parameter" or "PatchBaseline" – Required

Returns a list of tags for a specific resource type.

ResourceId = ::String – Required

The resource ID for which you want to see a list of tags.

Returns

ListTagsForResourceResult

Exceptions

InvalidResourceType, InvalidResourceId or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.modify_document_permission
modify_document_permission([::AWSConfig], arguments::Dict)
modify_document_permission([::AWSConfig]; Name=, PermissionType=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "ModifyDocumentPermission", arguments::Dict)
ssm([::AWSConfig], "ModifyDocumentPermission", Name=, PermissionType=, <keyword arguments>)

ModifyDocumentPermission Operation

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.

Arguments

Name = ::String – Required

The name of the document that you want to share.

PermissionType = "Share" – Required

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

AccountIdsToAdd = [::String, ...]

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 = [::String, ...]

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.

Returns

ModifyDocumentPermissionResponse

Exceptions

InternalServerError, InvalidDocument, InvalidPermissionType, DocumentPermissionLimit or DocumentLimitExceeded.

See also: AWS API Documentation

using AWSSDK.SSM.put_compliance_items
put_compliance_items([::AWSConfig], arguments::Dict)
put_compliance_items([::AWSConfig]; ResourceId=, ResourceType=, ComplianceType=, ExecutionSummary=, Items=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "PutComplianceItems", arguments::Dict)
ssm([::AWSConfig], "PutComplianceItems", ResourceId=, ResourceType=, ComplianceType=, ExecutionSummary=, Items=, <keyword arguments>)

PutComplianceItems Operation

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.

Arguments

ResourceId = ::String – Required

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

ResourceType = ::String – Required

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

ComplianceType = ::String – Required

Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

ExecutionSummary = [ ... ] – Required

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

 ExecutionSummary = [
        "ExecutionTime" => <required> timestamp,
        "ExecutionId" =>  ::String,
        "ExecutionType" =>  ::String
    ]

Items = [[ ... ], ...] – Required

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.

 Items = [[
        "Id" =>  ::String,
        "Title" =>  ::String,
        "Severity" => <required> "CRITICAL", "HIGH", "MEDIUM", "LOW", "INFORMATIONAL" or "UNSPECIFIED",
        "Status" => <required> "COMPLIANT" or "NON_COMPLIANT",
        "Details" =>  ::Dict{String,String}
    ], ...]

ItemContentHash = ::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.

Returns

PutComplianceItemsResult

Exceptions

InternalServerError, InvalidItemContentException, TotalSizeLimitExceededException, ItemSizeLimitExceededException, ComplianceTypeCountLimitExceededException, InvalidResourceType or InvalidResourceId.

See also: AWS API Documentation

using AWSSDK.SSM.put_inventory
put_inventory([::AWSConfig], arguments::Dict)
put_inventory([::AWSConfig]; InstanceId=, Items=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "PutInventory", arguments::Dict)
ssm([::AWSConfig], "PutInventory", InstanceId=, Items=)

PutInventory Operation

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.

Arguments

InstanceId = ::String – Required

One or more instance IDs where you want to add or update inventory items.

Items = [[ ... ], ...] – Required

The inventory items that you want to add or update on instances.

 Items = [[
        "TypeName" => <required> ::String,
        "SchemaVersion" => <required> ::String,
        "CaptureTime" => <required> ::String,
        "ContentHash" =>  ::String,
        "Content" =>  [::Dict{String,String}, ...],
        "Context" =>  ::Dict{String,String}
    ], ...]

Returns

PutInventoryResult

Exceptions

InternalServerError, InvalidInstanceId, InvalidTypeNameException, InvalidItemContentException, TotalSizeLimitExceededException, ItemSizeLimitExceededException, ItemContentMismatchException, CustomSchemaCountLimitExceededException, UnsupportedInventorySchemaVersionException, UnsupportedInventoryItemContextException, InvalidInventoryItemContextException or SubTypeCountLimitExceededException.

See also: AWS API Documentation

using AWSSDK.SSM.put_parameter
put_parameter([::AWSConfig], arguments::Dict)
put_parameter([::AWSConfig]; Name=, Value=, Type=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "PutParameter", arguments::Dict)
ssm([::AWSConfig], "PutParameter", Name=, Value=, Type=, <keyword arguments>)

PutParameter Operation

Add one or more parameters to the system.

Arguments

Name = ::String – Required

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

Description = ::String

Information about the parameter that you want to add to the system

Value = ::String – Required

The parameter value that you want to add to the system.

Type = "String", "StringList" or "SecureString" – Required

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

KeyId = ::String

The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account.

Overwrite = ::Bool

Overwrite an existing parameter. If not specified, will default to "false".

AllowedPattern = ::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+$

Returns

PutParameterResult

Exceptions

InternalServerError, InvalidKeyId, ParameterLimitExceeded, TooManyUpdates, ParameterAlreadyExists, HierarchyLevelLimitExceededException, HierarchyTypeMismatchException, InvalidAllowedPatternException, ParameterMaxVersionLimitExceeded, ParameterPatternMismatchException or UnsupportedParameterType.

See also: AWS API Documentation

using AWSSDK.SSM.register_default_patch_baseline
register_default_patch_baseline([::AWSConfig], arguments::Dict)
register_default_patch_baseline([::AWSConfig]; BaselineId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "RegisterDefaultPatchBaseline", arguments::Dict)
ssm([::AWSConfig], "RegisterDefaultPatchBaseline", BaselineId=)

RegisterDefaultPatchBaseline Operation

Defines the default patch baseline.

Arguments

BaselineId = ::String – Required

The ID of the patch baseline that should be the default patch baseline.

Returns

RegisterDefaultPatchBaselineResult

Exceptions

InvalidResourceId, DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.register_patch_baseline_for_patch_group
register_patch_baseline_for_patch_group([::AWSConfig], arguments::Dict)
register_patch_baseline_for_patch_group([::AWSConfig]; BaselineId=, PatchGroup=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "RegisterPatchBaselineForPatchGroup", arguments::Dict)
ssm([::AWSConfig], "RegisterPatchBaselineForPatchGroup", BaselineId=, PatchGroup=)

RegisterPatchBaselineForPatchGroup Operation

Registers a patch baseline for a patch group.

Arguments

BaselineId = ::String – Required

The ID of the patch baseline to register the patch group with.

PatchGroup = ::String – Required

The name of the patch group that should be registered with the patch baseline.

Returns

RegisterPatchBaselineForPatchGroupResult

Exceptions

AlreadyExistsException, DoesNotExistException, InvalidResourceId, ResourceLimitExceededException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.register_target_with_maintenance_window
register_target_with_maintenance_window([::AWSConfig], arguments::Dict)
register_target_with_maintenance_window([::AWSConfig]; WindowId=, ResourceType=, Targets=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "RegisterTargetWithMaintenanceWindow", arguments::Dict)
ssm([::AWSConfig], "RegisterTargetWithMaintenanceWindow", WindowId=, ResourceType=, Targets=, <keyword arguments>)

RegisterTargetWithMaintenanceWindow Operation

Registers a target with a Maintenance Window.

Arguments

WindowId = ::String – Required

The ID of the Maintenance Window the target should be registered with.

ResourceType = "INSTANCE" – Required

The type of target being registered with the Maintenance Window.

Targets = [[ ... ], ...] – Required

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

 Targets = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

OwnerInformation = ::String

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

Name = ::String

An optional name for the target.

Description = ::String

An optional description for the target.

ClientToken = ::String

User-provided idempotency token.

Returns

RegisterTargetWithMaintenanceWindowResult

Exceptions

IdempotentParameterMismatch, DoesNotExistException, ResourceLimitExceededException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.register_task_with_maintenance_window
register_task_with_maintenance_window([::AWSConfig], arguments::Dict)
register_task_with_maintenance_window([::AWSConfig]; WindowId=, Targets=, TaskArn=, ServiceRoleArn=, TaskType=, MaxConcurrency=, MaxErrors=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "RegisterTaskWithMaintenanceWindow", arguments::Dict)
ssm([::AWSConfig], "RegisterTaskWithMaintenanceWindow", WindowId=, Targets=, TaskArn=, ServiceRoleArn=, TaskType=, MaxConcurrency=, MaxErrors=, <keyword arguments>)

RegisterTaskWithMaintenanceWindow Operation

Adds a new task to a Maintenance Window.

Arguments

WindowId = ::String – Required

The id of the Maintenance Window the task should be added to.

Targets = [[ ... ], ...] – Required

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

 Targets = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

TaskArn = ::String – Required

The ARN of the task to execute

ServiceRoleArn = ::String – Required

The role that should be assumed when executing the task.

TaskType = "RUN_COMMAND", "AUTOMATION", "STEP_FUNCTIONS" or "LAMBDA" – Required

The type of task being registered.

TaskParameters = ::Dict{String,String}

The parameters that should be passed to the task when it is executed.

TaskInvocationParameters = [ ... ]

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

 TaskInvocationParameters = [
        "RunCommand" =>  [
            "Comment" =>  ::String,
            "DocumentHash" =>  ::String,
            "DocumentHashType" =>  "Sha256" or "Sha1",
            "NotificationConfig" =>  [
                "NotificationArn" =>  ::String,
                "NotificationEvents" =>  ["All", "InProgress", "Success", "TimedOut", "Cancelled" or "Failed", ...],
                "NotificationType" =>  "Command" or "Invocation"
            ],
            "OutputS3BucketName" =>  ::String,
            "OutputS3KeyPrefix" =>  ::String,
            "Parameters" =>  ::Dict{String,String},
            "ServiceRoleArn" =>  ::String,
            "TimeoutSeconds" =>  ::Int
        ],
        "Automation" =>  [
            "DocumentVersion" =>  ::String,
            "Parameters" =>  ::Dict{String,String}
        ],
        "StepFunctions" =>  [
            "Input" =>  ::String,
            "Name" =>  ::String
        ],
        "Lambda" =>  [
            "ClientContext" =>  ::String,
            "Qualifier" =>  ::String,
            "Payload" =>  blob
        ]
    ]

Priority = ::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.

MaxConcurrency = ::String – Required

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

MaxErrors = ::String – Required

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

LoggingInfo = [ ... ]

A structure containing information about an Amazon S3 bucket to write instance-level logs to.

 LoggingInfo = [
        "S3BucketName" => <required> ::String,
        "S3KeyPrefix" =>  ::String,
        "S3Region" => <required> ::String
    ]

Name = ::String

An optional name for the task.

Description = ::String

An optional description for the task.

ClientToken = ::String

User-provided idempotency token.

Returns

RegisterTaskWithMaintenanceWindowResult

Exceptions

IdempotentParameterMismatch, DoesNotExistException, ResourceLimitExceededException, FeatureNotAvailableException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.remove_tags_from_resource
remove_tags_from_resource([::AWSConfig], arguments::Dict)
remove_tags_from_resource([::AWSConfig]; ResourceType=, ResourceId=, TagKeys=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "RemoveTagsFromResource", arguments::Dict)
ssm([::AWSConfig], "RemoveTagsFromResource", ResourceType=, ResourceId=, TagKeys=)

RemoveTagsFromResource Operation

Removes all tags from the specified resource.

Arguments

ResourceType = "Document", "ManagedInstance", "MaintenanceWindow", "Parameter" or "PatchBaseline" – Required

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

ResourceId = ::String – Required

The resource ID for which you want to remove tags.

TagKeys = [::String, ...] – Required

Tag keys that you want to remove from the specified resource.

Returns

RemoveTagsFromResourceResult

Exceptions

InvalidResourceType, InvalidResourceId or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.send_automation_signal
send_automation_signal([::AWSConfig], arguments::Dict)
send_automation_signal([::AWSConfig]; AutomationExecutionId=, SignalType=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "SendAutomationSignal", arguments::Dict)
ssm([::AWSConfig], "SendAutomationSignal", AutomationExecutionId=, SignalType=, <keyword arguments>)

SendAutomationSignal Operation

Sends a signal to an Automation execution to change the current behavior or status of the execution.

Arguments

AutomationExecutionId = ::String – Required

The unique identifier for an existing Automation execution that you want to send the signal to.

SignalType = "Approve" or "Reject" – Required

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

Payload = ::Dict{String,String}

The data sent with the signal. The data schema depends on the type of signal used in the request.

Returns

SendAutomationSignalResult

Exceptions

AutomationExecutionNotFoundException, InvalidAutomationSignalException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.send_command
send_command([::AWSConfig], arguments::Dict)
send_command([::AWSConfig]; DocumentName=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "SendCommand", arguments::Dict)
ssm([::AWSConfig], "SendCommand", DocumentName=, <keyword arguments>)

SendCommand Operation

Executes commands on one or more managed instances.

Arguments

InstanceIds = [::String, ...]

The instance IDs where the command should execute. 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.

Targets = [[ ... ], ...]

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

 Targets = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

DocumentName = ::String – Required

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

DocumentHash = ::String

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

Note

Sha1 hashes have been deprecated.

DocumentHashType = "Sha256" or "Sha1"

Sha256 or Sha1.

Note

Sha1 hashes have been deprecated.

TimeoutSeconds = ::Int

If this time is reached and the command has not already started executing, it will not execute.

Comment = ::String

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

Parameters = ::Dict{String,String}

The required and optional parameters specified in the document being executed.

OutputS3Region = ::String

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

OutputS3BucketName = ::String

The name of the S3 bucket where command execution responses should be stored.

OutputS3KeyPrefix = ::String

The directory structure within the S3 bucket where the responses should be stored.

MaxConcurrency = ::String

(Optional) The maximum number of instances that are allowed to execute 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.

MaxErrors = ::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 50. For more information about how to use MaxErrors, see Using Error Controls.

ServiceRoleArn = ::String

The IAM role that Systems Manager uses to send notifications.

NotificationConfig = [ ... ]

Configurations for sending notifications.

 NotificationConfig = [
        "NotificationArn" =>  ::String,
        "NotificationEvents" =>  ["All", "InProgress", "Success", "TimedOut", "Cancelled" or "Failed", ...],
        "NotificationType" =>  "Command" or "Invocation"
    ]

Returns

SendCommandResult

Exceptions

DuplicateInstanceId, InternalServerError, InvalidInstanceId, InvalidDocument, InvalidOutputFolder, InvalidParameters, UnsupportedPlatformType, MaxDocumentSizeExceeded, InvalidRole or InvalidNotificationConfig.

See also: AWS API Documentation

using AWSSDK.SSM.start_automation_execution
start_automation_execution([::AWSConfig], arguments::Dict)
start_automation_execution([::AWSConfig]; DocumentName=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "StartAutomationExecution", arguments::Dict)
ssm([::AWSConfig], "StartAutomationExecution", DocumentName=, <keyword arguments>)

StartAutomationExecution Operation

Initiates execution of an Automation document.

Arguments

DocumentName = ::String – Required

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

DocumentVersion = ::String

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

Parameters = ::Dict{String,String}

A key-value map of execution parameters, which match the declared parameters in the Automation document.

ClientToken = ::String

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Returns

StartAutomationExecutionResult

Exceptions

AutomationDefinitionNotFoundException, InvalidAutomationExecutionParametersException, AutomationExecutionLimitExceededException, AutomationDefinitionVersionNotFoundException, IdempotentParameterMismatch or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.stop_automation_execution
stop_automation_execution([::AWSConfig], arguments::Dict)
stop_automation_execution([::AWSConfig]; AutomationExecutionId=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "StopAutomationExecution", arguments::Dict)
ssm([::AWSConfig], "StopAutomationExecution", AutomationExecutionId=)

StopAutomationExecution Operation

Stop an Automation that is currently executing.

Arguments

AutomationExecutionId = ::String – Required

The execution ID of the Automation to stop.

Returns

StopAutomationExecutionResult

Exceptions

AutomationExecutionNotFoundException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.update_association
update_association([::AWSConfig], arguments::Dict)
update_association([::AWSConfig]; AssociationId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "UpdateAssociation", arguments::Dict)
ssm([::AWSConfig], "UpdateAssociation", AssociationId=, <keyword arguments>)

UpdateAssociation Operation

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

Arguments

AssociationId = ::String – Required

The ID of the association you want to update.

Parameters = ::Dict{String,String}

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

DocumentVersion = ::String

The document version you want update for the association.

ScheduleExpression = ::String

The cron expression used to schedule the association that you want to update.

OutputLocation = ["S3Location" => [ ... ]]

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

 OutputLocation = ["S3Location" =>  [
            "OutputS3Region" =>  ::String,
            "OutputS3BucketName" =>  ::String,
            "OutputS3KeyPrefix" =>  ::String
        ]]

Name = ::String

The name of the association document.

Targets = [[ ... ], ...]

The targets of the association.

 Targets = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

AssociationName = ::String

The name of the association that you want to update.

AssociationVersion = ::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.

Returns

UpdateAssociationResult

Exceptions

InternalServerError, InvalidSchedule, InvalidParameters, InvalidOutputLocation, InvalidDocumentVersion, AssociationDoesNotExist, InvalidUpdate, TooManyUpdates, InvalidDocument, InvalidTarget, InvalidAssociationVersion or AssociationVersionLimitExceeded.

See also: AWS API Documentation

using AWSSDK.SSM.update_association_status
update_association_status([::AWSConfig], arguments::Dict)
update_association_status([::AWSConfig]; Name=, InstanceId=, AssociationStatus=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "UpdateAssociationStatus", arguments::Dict)
ssm([::AWSConfig], "UpdateAssociationStatus", Name=, InstanceId=, AssociationStatus=)

UpdateAssociationStatus Operation

Updates the status of the Systems Manager document associated with the specified instance.

Arguments

Name = ::String – Required

The name of the Systems Manager document.

InstanceId = ::String – Required

The ID of the instance.

AssociationStatus = [ ... ] – Required

The association status.

 AssociationStatus = [
        "Date" => <required> timestamp,
        "Name" => <required> "Pending", "Success" or "Failed",
        "Message" => <required> ::String,
        "AdditionalInfo" =>  ::String
    ]

Returns

UpdateAssociationStatusResult

Exceptions

InternalServerError, InvalidInstanceId, InvalidDocument, AssociationDoesNotExist, StatusUnchanged or TooManyUpdates.

See also: AWS API Documentation

using AWSSDK.SSM.update_document
update_document([::AWSConfig], arguments::Dict)
update_document([::AWSConfig]; Content=, Name=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "UpdateDocument", arguments::Dict)
ssm([::AWSConfig], "UpdateDocument", Content=, Name=, <keyword arguments>)

UpdateDocument Operation

The document you want to update.

Arguments

Content = ::String – Required

The content in a document that you want to update.

Name = ::String – Required

The name of the document that you want to update.

DocumentVersion = ::String

The version of the document that you want to update.

Returns

UpdateDocumentResult

Exceptions

MaxDocumentSizeExceeded, DocumentVersionLimitExceeded, InternalServerError, DuplicateDocumentContent, InvalidDocumentContent, InvalidDocumentVersion, InvalidDocumentSchemaVersion or InvalidDocument.

See also: AWS API Documentation

using AWSSDK.SSM.update_document_default_version
update_document_default_version([::AWSConfig], arguments::Dict)
update_document_default_version([::AWSConfig]; Name=, DocumentVersion=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "UpdateDocumentDefaultVersion", arguments::Dict)
ssm([::AWSConfig], "UpdateDocumentDefaultVersion", Name=, DocumentVersion=)

UpdateDocumentDefaultVersion Operation

Set the default version of a document.

Arguments

Name = ::String – Required

The name of a custom document that you want to set as the default version.

DocumentVersion = ::String – Required

The version of a custom document that you want to set as the default version.

Returns

UpdateDocumentDefaultVersionResult

Exceptions

InternalServerError, InvalidDocument, InvalidDocumentVersion or InvalidDocumentSchemaVersion.

See also: AWS API Documentation

using AWSSDK.SSM.update_maintenance_window
update_maintenance_window([::AWSConfig], arguments::Dict)
update_maintenance_window([::AWSConfig]; WindowId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "UpdateMaintenanceWindow", arguments::Dict)
ssm([::AWSConfig], "UpdateMaintenanceWindow", WindowId=, <keyword arguments>)

UpdateMaintenanceWindow Operation

Updates an existing Maintenance Window. Only specified parameters are modified.

Arguments

WindowId = ::String – Required

The ID of the Maintenance Window to update.

Name = ::String

The name of the Maintenance Window.

Description = ::String

An optional description for the update request.

Schedule = ::String

The schedule of the Maintenance Window in the form of a cron or rate expression.

Duration = ::Int

The duration of the Maintenance Window in hours.

Cutoff = ::Int

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

AllowUnassociatedTargets = ::Bool

Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

Enabled = ::Bool

Whether the Maintenance Window is enabled.

Replace = ::Bool

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.

Returns

UpdateMaintenanceWindowResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.update_maintenance_window_target
update_maintenance_window_target([::AWSConfig], arguments::Dict)
update_maintenance_window_target([::AWSConfig]; WindowId=, WindowTargetId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "UpdateMaintenanceWindowTarget", arguments::Dict)
ssm([::AWSConfig], "UpdateMaintenanceWindowTarget", WindowId=, WindowTargetId=, <keyword arguments>)

UpdateMaintenanceWindowTarget Operation

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.

Arguments

WindowId = ::String – Required

The Maintenance Window ID with which to modify the target.

WindowTargetId = ::String – Required

The target ID to modify.

Targets = [[ ... ], ...]

The targets to add or replace.

 Targets = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

OwnerInformation = ::String

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

Name = ::String

A name for the update.

Description = ::String

An optional description for the update.

Replace = ::Bool

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.

Returns

UpdateMaintenanceWindowTargetResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.update_maintenance_window_task
update_maintenance_window_task([::AWSConfig], arguments::Dict)
update_maintenance_window_task([::AWSConfig]; WindowId=, WindowTaskId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "UpdateMaintenanceWindowTask", arguments::Dict)
ssm([::AWSConfig], "UpdateMaintenanceWindowTask", WindowId=, WindowTaskId=, <keyword arguments>)

UpdateMaintenanceWindowTask Operation

Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values:

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

Service role ARN.

Task parameters.

Task priority.

Task MaxConcurrency and MaxErrors.

Log location.

If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.

Arguments

WindowId = ::String – Required

The Maintenance Window ID that contains the task to modify.

WindowTaskId = ::String – Required

The task ID to modify.

Targets = [[ ... ], ...]

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.

 Targets = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

TaskArn = ::String

The task ARN to modify.

ServiceRoleArn = ::String

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

TaskParameters = ::Dict{String,String}

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

TaskInvocationParameters = [ ... ]

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

 TaskInvocationParameters = [
        "RunCommand" =>  [
            "Comment" =>  ::String,
            "DocumentHash" =>  ::String,
            "DocumentHashType" =>  "Sha256" or "Sha1",
            "NotificationConfig" =>  [
                "NotificationArn" =>  ::String,
                "NotificationEvents" =>  ["All", "InProgress", "Success", "TimedOut", "Cancelled" or "Failed", ...],
                "NotificationType" =>  "Command" or "Invocation"
            ],
            "OutputS3BucketName" =>  ::String,
            "OutputS3KeyPrefix" =>  ::String,
            "Parameters" =>  ::Dict{String,String},
            "ServiceRoleArn" =>  ::String,
            "TimeoutSeconds" =>  ::Int
        ],
        "Automation" =>  [
            "DocumentVersion" =>  ::String,
            "Parameters" =>  ::Dict{String,String}
        ],
        "StepFunctions" =>  [
            "Input" =>  ::String,
            "Name" =>  ::String
        ],
        "Lambda" =>  [
            "ClientContext" =>  ::String,
            "Qualifier" =>  ::String,
            "Payload" =>  blob
        ]
    ]

Priority = ::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.

MaxConcurrency = ::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 = ::String

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

LoggingInfo = [ ... ]

The new logging location in Amazon S3 to specify.

 LoggingInfo = [
        "S3BucketName" => <required> ::String,
        "S3KeyPrefix" =>  ::String,
        "S3Region" => <required> ::String
    ]

Name = ::String

The new task name to specify.

Description = ::String

The new task description to specify.

Replace = ::Bool

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.

Returns

UpdateMaintenanceWindowTaskResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.update_managed_instance_role
update_managed_instance_role([::AWSConfig], arguments::Dict)
update_managed_instance_role([::AWSConfig]; InstanceId=, IamRole=)

using AWSCore.Services.ssm
ssm([::AWSConfig], "UpdateManagedInstanceRole", arguments::Dict)
ssm([::AWSConfig], "UpdateManagedInstanceRole", InstanceId=, IamRole=)

UpdateManagedInstanceRole Operation

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

Arguments

InstanceId = ::String – Required

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

IamRole = ::String – Required

The IAM role you want to assign or change.

Returns

UpdateManagedInstanceRoleResult

Exceptions

InvalidInstanceId or InternalServerError.

See also: AWS API Documentation

using AWSSDK.SSM.update_patch_baseline
update_patch_baseline([::AWSConfig], arguments::Dict)
update_patch_baseline([::AWSConfig]; BaselineId=, <keyword arguments>)

using AWSCore.Services.ssm
ssm([::AWSConfig], "UpdatePatchBaseline", arguments::Dict)
ssm([::AWSConfig], "UpdatePatchBaseline", BaselineId=, <keyword arguments>)

UpdatePatchBaseline Operation

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

Arguments

BaselineId = ::String – Required

The ID of the patch baseline to update.

Name = ::String

The name of the patch baseline.

GlobalFilters = ["PatchFilters" => <required> [[ ... ], ...]]

A set of global filters used to exclude patches from the baseline.

 GlobalFilters = ["PatchFilters" => <required> [[
            "Key" => <required> "PRODUCT", "CLASSIFICATION", "MSRC_SEVERITY", "PATCH_ID", "SECTION", "PRIORITY" or "SEVERITY",
            "Values" => <required> [::String, ...]
        ], ...]]

ApprovalRules = ["PatchRules" => <required> [[ ... ], ...]]

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

 ApprovalRules = ["PatchRules" => <required> [[
            "PatchFilterGroup" => <required> ["PatchFilters" => <required> [[
                    "Key" => <required> "PRODUCT", "CLASSIFICATION", "MSRC_SEVERITY", "PATCH_ID", "SECTION", "PRIORITY" or "SEVERITY",
                    "Values" => <required> [::String, ...]
                ], ...]],
            "ComplianceLevel" =>  "CRITICAL", "HIGH", "MEDIUM", "LOW", "INFORMATIONAL" or "UNSPECIFIED",
            "ApproveAfterDays" => <required> ::Int
        ], ...]]

ApprovedPatches = [::String, ...]

A list of explicitly approved patches for the baseline.

ApprovedPatchesComplianceLevel = "CRITICAL", "HIGH", "MEDIUM", "LOW", "INFORMATIONAL" or "UNSPECIFIED"

Assigns a new compliance severity level to an existing patch baseline.

RejectedPatches = [::String, ...]

A list of explicitly rejected patches for the baseline.

Description = ::String

A description of the patch baseline.

Returns

UpdatePatchBaselineResult

Exceptions

DoesNotExistException or InternalServerError.

See also: AWS API Documentation