Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.Lens

Contents

Operations
Types

Description

Synopsis

Operations

AddTagsToResource

addTagsToResource_resourceType :: Lens' AddTagsToResource ResourceTypeForTagging Source #

Specifies the type of resource you are tagging.

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

addTagsToResource_resourceId :: Lens' AddTagsToResource Text Source #

The resource ID you want to tag.

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

MaintenanceWindow: mw-012345abcde

PatchBaseline: pb-012345abcde

Automation: example-c160-4567-8519-012345abcde

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

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

ManagedInstance: mi-012345abcde

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

addTagsToResource_tags :: Lens' AddTagsToResource [Tag] Source #

One or more tags. The value parameter is required.

Don't enter personally identifiable information in this field.

addTagsToResourceResponse_httpStatus :: Lens' AddTagsToResourceResponse Int Source #

The response's http status code.

AssociateOpsItemRelatedItem

associateOpsItemRelatedItem_opsItemId :: Lens' AssociateOpsItemRelatedItem Text Source #

The ID of the OpsItem to which you want to associate a resource as a related item.

associateOpsItemRelatedItem_associationType :: Lens' AssociateOpsItemRelatedItem Text Source #

The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types.

associateOpsItemRelatedItem_resourceType :: Lens' AssociateOpsItemRelatedItem Text Source #

The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:

AWS::SSMIncidents::IncidentRecord: an Incident Manager incident.

AWS::SSM::Document: a Systems Manager (SSM) document.

associateOpsItemRelatedItem_resourceUri :: Lens' AssociateOpsItemRelatedItem Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.

associateOpsItemRelatedItemResponse_associationId :: Lens' AssociateOpsItemRelatedItemResponse (Maybe Text) Source #

The association ID.

associateOpsItemRelatedItemResponse_httpStatus :: Lens' AssociateOpsItemRelatedItemResponse Int Source #

The response's http status code.

CancelCommand

cancelCommand_instanceIds :: Lens' CancelCommand (Maybe [Text]) Source #

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

cancelCommand_commandId :: Lens' CancelCommand Text Source #

The ID of the command you want to cancel.

cancelCommandResponse_httpStatus :: Lens' CancelCommandResponse Int Source #

The response's http status code.

CancelMaintenanceWindowExecution

cancelMaintenanceWindowExecution_windowExecutionId :: Lens' CancelMaintenanceWindowExecution Text Source #

The ID of the maintenance window execution to stop.

cancelMaintenanceWindowExecutionResponse_windowExecutionId :: Lens' CancelMaintenanceWindowExecutionResponse (Maybe Text) Source #

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

cancelMaintenanceWindowExecutionResponse_httpStatus :: Lens' CancelMaintenanceWindowExecutionResponse Int Source #

The response's http status code.

CreateActivation

createActivation_defaultInstanceName :: Lens' CreateActivation (Maybe Text) Source #

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

Don't enter personally identifiable information in this field.

createActivation_description :: Lens' CreateActivation (Maybe Text) Source #

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

Don't enter personally identifiable information in this field.

createActivation_expirationDate :: Lens' CreateActivation (Maybe UTCTime) Source #

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

createActivation_registrationLimit :: Lens' CreateActivation (Maybe Natural) Source #

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

createActivation_registrationMetadata :: Lens' CreateActivation (Maybe [RegistrationMetadataItem]) Source #

Reserved for internal use.

createActivation_tags :: Lens' CreateActivation (Maybe [Tag]) Source #

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

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

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

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

createActivation_iamRole :: Lens' CreateActivation Text Source #

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

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

createActivationResponse_activationCode :: Lens' CreateActivationResponse (Maybe Text) Source #

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

createActivationResponse_activationId :: Lens' CreateActivationResponse (Maybe Text) Source #

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

createActivationResponse_httpStatus :: Lens' CreateActivationResponse Int Source #

The response's http status code.

CreateAssociation

createAssociation_alarmConfiguration :: Lens' CreateAssociation (Maybe AlarmConfiguration) Source #

Undocumented member.

createAssociation_applyOnlyAtCronInterval :: Lens' CreateAssociation (Maybe Bool) Source #

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

createAssociation_associationName :: Lens' CreateAssociation (Maybe Text) Source #

Specify a descriptive name for the association.

createAssociation_automationTargetParameterName :: Lens' CreateAssociation (Maybe Text) Source #

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

createAssociation_calendarNames :: Lens' CreateAssociation (Maybe [Text]) Source #

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

createAssociation_complianceSeverity :: Lens' CreateAssociation (Maybe AssociationComplianceSeverity) Source #

The severity level to assign to the association.

createAssociation_documentVersion :: Lens' CreateAssociation (Maybe Text) Source #

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

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

createAssociation_instanceId :: Lens' CreateAssociation (Maybe Text) Source #

The managed node ID.

InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

createAssociation_maxConcurrency :: Lens' CreateAssociation (Maybe Text) Source #

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

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

createAssociation_maxErrors :: Lens' CreateAssociation (Maybe Text) Source #

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

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

createAssociation_outputLocation :: Lens' CreateAssociation (Maybe InstanceAssociationOutputLocation) Source #

An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

createAssociation_parameters :: Lens' CreateAssociation (Maybe (HashMap Text [Text])) Source #

The parameters for the runtime configuration of the document.

createAssociation_scheduleExpression :: Lens' CreateAssociation (Maybe Text) Source #

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

createAssociation_scheduleOffset :: Lens' CreateAssociation (Maybe Natural) Source #

Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it.

createAssociation_syncCompliance :: Lens' CreateAssociation (Maybe AssociationSyncCompliance) Source #

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

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

By default, all associations use AUTO mode.

createAssociation_tags :: Lens' CreateAssociation (Maybe [Tag]) Source #

Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. 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.

createAssociation_targetLocations :: Lens' CreateAssociation (Maybe (NonEmpty TargetLocation)) Source #

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

createAssociation_targetMaps :: Lens' CreateAssociation (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

createAssociation_targets :: Lens' CreateAssociation (Maybe [Target]) Source #

The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.

createAssociation_name :: Lens' CreateAssociation Text Source #

The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.

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

For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:

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

For example:

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

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

createAssociationResponse_associationDescription :: Lens' CreateAssociationResponse (Maybe AssociationDescription) Source #

Information about the association.

createAssociationResponse_httpStatus :: Lens' CreateAssociationResponse Int Source #

The response's http status code.

CreateAssociationBatch

createAssociationBatch_entries :: Lens' CreateAssociationBatch (NonEmpty CreateAssociationBatchRequestEntry) Source #

One or more associations.

createAssociationBatchResponse_failed :: Lens' CreateAssociationBatchResponse (Maybe [FailedCreateAssociation]) Source #

Information about the associations that failed.

createAssociationBatchResponse_successful :: Lens' CreateAssociationBatchResponse (Maybe [AssociationDescription]) Source #

Information about the associations that succeeded.

createAssociationBatchResponse_httpStatus :: Lens' CreateAssociationBatchResponse Int Source #

The response's http status code.

CreateDocument

createDocument_attachments :: Lens' CreateDocument (Maybe [AttachmentsSource]) Source #

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

createDocument_displayName :: Lens' CreateDocument (Maybe Text) Source #

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

createDocument_documentFormat :: Lens' CreateDocument (Maybe DocumentFormat) Source #

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

createDocument_documentType :: Lens' CreateDocument (Maybe DocumentType) Source #

The type of document to create.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

createDocument_requires :: Lens' CreateDocument (Maybe (NonEmpty DocumentRequires)) Source #

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

createDocument_tags :: Lens' CreateDocument (Maybe [Tag]) Source #

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

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

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

createDocument_targetType :: Lens' CreateDocument (Maybe Text) Source #

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

createDocument_versionName :: Lens' CreateDocument (Maybe Text) Source #

An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can't be changed.

createDocument_content :: Lens' CreateDocument Text Source #

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

For examples, see the following topics in the /Amazon Web Services Systems Manager User Guide/.

createDocument_name :: Lens' CreateDocument Text Source #

A name for the SSM document.

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

```
aws
```
```
amazon
```
```
amzn
```

createDocumentResponse_documentDescription :: Lens' CreateDocumentResponse (Maybe DocumentDescription) Source #

Information about the SSM document.

createDocumentResponse_httpStatus :: Lens' CreateDocumentResponse Int Source #

The response's http status code.

CreateMaintenanceWindow

createMaintenanceWindow_clientToken :: Lens' CreateMaintenanceWindow (Maybe Text) Source #

User-provided idempotency token.

createMaintenanceWindow_description :: Lens' CreateMaintenanceWindow (Maybe Text) Source #

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

createMaintenanceWindow_endDate :: Lens' CreateMaintenanceWindow (Maybe Text) Source #

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

createMaintenanceWindow_scheduleOffset :: Lens' CreateMaintenanceWindow (Maybe Natural) Source #

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

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

cron(30 23 ? * TUE#3 *)

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

createMaintenanceWindow_scheduleTimezone :: Lens' CreateMaintenanceWindow (Maybe Text) Source #

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

createMaintenanceWindow_startDate :: Lens' CreateMaintenanceWindow (Maybe Text) Source #

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

createMaintenanceWindow_tags :: Lens' CreateMaintenanceWindow (Maybe [Tag]) Source #

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

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

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

createMaintenanceWindow_name :: Lens' CreateMaintenanceWindow Text Source #

The name of the maintenance window.

createMaintenanceWindow_schedule :: Lens' CreateMaintenanceWindow Text Source #

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

createMaintenanceWindow_duration :: Lens' CreateMaintenanceWindow Natural Source #

The duration of the maintenance window in hours.

createMaintenanceWindow_cutoff :: Lens' CreateMaintenanceWindow Natural Source #

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

createMaintenanceWindow_allowUnassociatedTargets :: Lens' CreateMaintenanceWindow Bool Source #

Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node 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.

createMaintenanceWindowResponse_windowId :: Lens' CreateMaintenanceWindowResponse (Maybe Text) Source #

The ID of the created maintenance window.

createMaintenanceWindowResponse_httpStatus :: Lens' CreateMaintenanceWindowResponse Int Source #

The response's http status code.

CreateOpsItem

createOpsItem_accountId :: Lens' CreateOpsItem (Maybe Text) Source #

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Setting up OpsCenter to work with OpsItems across accounts in the Amazon Web Services Systems Manager User Guide.

createOpsItem_actualEndTime :: Lens' CreateOpsItem (Maybe UTCTime) Source #

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

createOpsItem_actualStartTime :: Lens' CreateOpsItem (Maybe UTCTime) Source #

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

createOpsItem_category :: Lens' CreateOpsItem (Maybe Text) Source #

Specify a category to assign to an OpsItem.

createOpsItem_notifications :: Lens' CreateOpsItem (Maybe [OpsItemNotification]) Source #

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

createOpsItem_operationalData :: Lens' CreateOpsItem (Maybe (HashMap Text OpsItemDataValue)) Source #

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

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

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

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

createOpsItem_opsItemType :: Lens' CreateOpsItem (Maybe Text) Source #

The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

```
/aws/issue
```
This type of OpsItem is used for default OpsItems created by OpsCenter.
```
/aws/changerequest
```
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
```
/aws/insights
```
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

createOpsItem_plannedEndTime :: Lens' CreateOpsItem (Maybe UTCTime) Source #

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

createOpsItem_plannedStartTime :: Lens' CreateOpsItem (Maybe UTCTime) Source #

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

createOpsItem_priority :: Lens' CreateOpsItem (Maybe Natural) Source #

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

createOpsItem_relatedOpsItems :: Lens' CreateOpsItem (Maybe [RelatedOpsItem]) Source #

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

createOpsItem_severity :: Lens' CreateOpsItem (Maybe Text) Source #

Specify a severity to assign to an OpsItem.

createOpsItem_tags :: Lens' CreateOpsItem (Maybe [Tag]) Source #

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

createOpsItem_description :: Lens' CreateOpsItem Text Source #

Information about the OpsItem.

createOpsItem_source :: Lens' CreateOpsItem Text Source #

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

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

createOpsItem_title :: Lens' CreateOpsItem Text Source #

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

createOpsItemResponse_opsItemArn :: Lens' CreateOpsItemResponse (Maybe Text) Source #

The OpsItem Amazon Resource Name (ARN).

createOpsItemResponse_opsItemId :: Lens' CreateOpsItemResponse (Maybe Text) Source #

The ID of the OpsItem.

createOpsItemResponse_httpStatus :: Lens' CreateOpsItemResponse Int Source #

The response's http status code.

CreateOpsMetadata

createOpsMetadata_metadata :: Lens' CreateOpsMetadata (Maybe (HashMap Text MetadataValue)) Source #

Metadata for a new Application Manager application.

createOpsMetadata_tags :: Lens' CreateOpsMetadata (Maybe [Tag]) Source #

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

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

createOpsMetadata_resourceId :: Lens' CreateOpsMetadata Text Source #

A resource ID for a new Application Manager application.

createOpsMetadataResponse_opsMetadataArn :: Lens' CreateOpsMetadataResponse (Maybe Text) Source #

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

createOpsMetadataResponse_httpStatus :: Lens' CreateOpsMetadataResponse Int Source #

The response's http status code.

CreatePatchBaseline

createPatchBaseline_approvalRules :: Lens' CreatePatchBaseline (Maybe PatchRuleGroup) Source #

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

createPatchBaseline_approvedPatches :: Lens' CreatePatchBaseline (Maybe [Text]) Source #

A list of explicitly approved patches for the baseline.

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

createPatchBaseline_approvedPatchesComplianceLevel :: Lens' CreatePatchBaseline (Maybe PatchComplianceLevel) Source #

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

createPatchBaseline_approvedPatchesEnableNonSecurity :: Lens' CreatePatchBaseline (Maybe Bool) Source #

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

createPatchBaseline_clientToken :: Lens' CreatePatchBaseline (Maybe Text) Source #

User-provided idempotency token.

createPatchBaseline_description :: Lens' CreatePatchBaseline (Maybe Text) Source #

A description of the patch baseline.

createPatchBaseline_globalFilters :: Lens' CreatePatchBaseline (Maybe PatchFilterGroup) Source #

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

createPatchBaseline_operatingSystem :: Lens' CreatePatchBaseline (Maybe OperatingSystem) Source #

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

createPatchBaseline_rejectedPatches :: Lens' CreatePatchBaseline (Maybe [Text]) Source #

A list of explicitly rejected patches for the baseline.

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

createPatchBaseline_rejectedPatchesAction :: Lens' CreatePatchBaseline (Maybe PatchAction) Source #

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

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

createPatchBaseline_sources :: Lens' CreatePatchBaseline (Maybe [PatchSource]) Source #

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

createPatchBaseline_tags :: Lens' CreatePatchBaseline (Maybe [Tag]) Source #

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

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

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

createPatchBaseline_name :: Lens' CreatePatchBaseline Text Source #

The name of the patch baseline.

createPatchBaselineResponse_baselineId :: Lens' CreatePatchBaselineResponse (Maybe Text) Source #

The ID of the created patch baseline.

createPatchBaselineResponse_httpStatus :: Lens' CreatePatchBaselineResponse Int Source #

The response's http status code.

CreateResourceDataSync

createResourceDataSync_s3Destination :: Lens' CreateResourceDataSync (Maybe ResourceDataSyncS3Destination) Source #

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

createResourceDataSync_syncSource :: Lens' CreateResourceDataSync (Maybe ResourceDataSyncSource) Source #

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

createResourceDataSync_syncType :: Lens' CreateResourceDataSync (Maybe Text) Source #

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

createResourceDataSync_syncName :: Lens' CreateResourceDataSync Text Source #

A name for the configuration.

createResourceDataSyncResponse_httpStatus :: Lens' CreateResourceDataSyncResponse Int Source #

The response's http status code.

DeleteActivation

deleteActivation_activationId :: Lens' DeleteActivation Text Source #

The ID of the activation that you want to delete.

deleteActivationResponse_httpStatus :: Lens' DeleteActivationResponse Int Source #

The response's http status code.

DeleteAssociation

deleteAssociation_associationId :: Lens' DeleteAssociation (Maybe Text) Source #

The association ID that you want to delete.

deleteAssociation_instanceId :: Lens' DeleteAssociation (Maybe Text) Source #

The managed node ID.

InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

deleteAssociation_name :: Lens' DeleteAssociation (Maybe Text) Source #

The name of the SSM document.

deleteAssociationResponse_httpStatus :: Lens' DeleteAssociationResponse Int Source #

The response's http status code.

DeleteDocument

deleteDocument_documentVersion :: Lens' DeleteDocument (Maybe Text) Source #

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

deleteDocument_force :: Lens' DeleteDocument (Maybe Bool) Source #

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

deleteDocument_versionName :: Lens' DeleteDocument (Maybe Text) Source #

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

deleteDocument_name :: Lens' DeleteDocument Text Source #

The name of the document.

deleteDocumentResponse_httpStatus :: Lens' DeleteDocumentResponse Int Source #

The response's http status code.

DeleteInventory

deleteInventory_clientToken :: Lens' DeleteInventory (Maybe Text) Source #

User-provided idempotency token.

deleteInventory_dryRun :: Lens' DeleteInventory (Maybe Bool) Source #

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

deleteInventory_schemaDeleteOption :: Lens' DeleteInventory (Maybe InventorySchemaDeleteOption) Source #

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

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

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

deleteInventory_typeName :: Lens' DeleteInventory Text Source #

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

deleteInventoryResponse_deletionId :: Lens' DeleteInventoryResponse (Maybe Text) Source #

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

deleteInventoryResponse_deletionSummary :: Lens' DeleteInventoryResponse (Maybe InventoryDeletionSummary) Source #

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

deleteInventoryResponse_typeName :: Lens' DeleteInventoryResponse (Maybe Text) Source #

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

deleteInventoryResponse_httpStatus :: Lens' DeleteInventoryResponse Int Source #

The response's http status code.

DeleteMaintenanceWindow

deleteMaintenanceWindow_windowId :: Lens' DeleteMaintenanceWindow Text Source #

The ID of the maintenance window to delete.

deleteMaintenanceWindowResponse_windowId :: Lens' DeleteMaintenanceWindowResponse (Maybe Text) Source #

The ID of the deleted maintenance window.

deleteMaintenanceWindowResponse_httpStatus :: Lens' DeleteMaintenanceWindowResponse Int Source #

The response's http status code.

DeleteOpsMetadata

deleteOpsMetadata_opsMetadataArn :: Lens' DeleteOpsMetadata Text Source #

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

deleteOpsMetadataResponse_httpStatus :: Lens' DeleteOpsMetadataResponse Int Source #

The response's http status code.

DeleteParameter

deleteParameter_name :: Lens' DeleteParameter Text Source #

The name of the parameter to delete.

deleteParameterResponse_httpStatus :: Lens' DeleteParameterResponse Int Source #

The response's http status code.

DeleteParameters

deleteParameters_names :: Lens' DeleteParameters (NonEmpty Text) Source #

The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

deleteParametersResponse_deletedParameters :: Lens' DeleteParametersResponse (Maybe (NonEmpty Text)) Source #

The names of the deleted parameters.

deleteParametersResponse_invalidParameters :: Lens' DeleteParametersResponse (Maybe (NonEmpty Text)) Source #

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

deleteParametersResponse_httpStatus :: Lens' DeleteParametersResponse Int Source #

The response's http status code.

DeletePatchBaseline

deletePatchBaseline_baselineId :: Lens' DeletePatchBaseline Text Source #

The ID of the patch baseline to delete.

deletePatchBaselineResponse_baselineId :: Lens' DeletePatchBaselineResponse (Maybe Text) Source #

The ID of the deleted patch baseline.

deletePatchBaselineResponse_httpStatus :: Lens' DeletePatchBaselineResponse Int Source #

The response's http status code.

DeleteResourceDataSync

deleteResourceDataSync_syncType :: Lens' DeleteResourceDataSync (Maybe Text) Source #

Specify the type of resource data sync to delete.

deleteResourceDataSync_syncName :: Lens' DeleteResourceDataSync Text Source #

The name of the configuration to delete.

deleteResourceDataSyncResponse_httpStatus :: Lens' DeleteResourceDataSyncResponse Int Source #

The response's http status code.

DeleteResourcePolicy

deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text Source #

Amazon Resource Name (ARN) of the resource to which the policies are attached.

deleteResourcePolicy_policyId :: Lens' DeleteResourcePolicy Text Source #

The policy ID.

deleteResourcePolicy_policyHash :: Lens' DeleteResourcePolicy Text Source #

ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.

deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int Source #

The response's http status code.

DeregisterManagedInstance

deregisterManagedInstance_instanceId :: Lens' DeregisterManagedInstance Text Source #

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

deregisterManagedInstanceResponse_httpStatus :: Lens' DeregisterManagedInstanceResponse Int Source #

The response's http status code.

DeregisterPatchBaselineForPatchGroup

deregisterPatchBaselineForPatchGroup_baselineId :: Lens' DeregisterPatchBaselineForPatchGroup Text Source #

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

deregisterPatchBaselineForPatchGroup_patchGroup :: Lens' DeregisterPatchBaselineForPatchGroup Text Source #

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

deregisterPatchBaselineForPatchGroupResponse_baselineId :: Lens' DeregisterPatchBaselineForPatchGroupResponse (Maybe Text) Source #

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

deregisterPatchBaselineForPatchGroupResponse_patchGroup :: Lens' DeregisterPatchBaselineForPatchGroupResponse (Maybe Text) Source #

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

deregisterPatchBaselineForPatchGroupResponse_httpStatus :: Lens' DeregisterPatchBaselineForPatchGroupResponse Int Source #

The response's http status code.

DeregisterTargetFromMaintenanceWindow

deregisterTargetFromMaintenanceWindow_safe :: Lens' DeregisterTargetFromMaintenanceWindow (Maybe Bool) Source #

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

deregisterTargetFromMaintenanceWindow_windowId :: Lens' DeregisterTargetFromMaintenanceWindow Text Source #

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

deregisterTargetFromMaintenanceWindow_windowTargetId :: Lens' DeregisterTargetFromMaintenanceWindow Text Source #

The ID of the target definition to remove.

deregisterTargetFromMaintenanceWindowResponse_windowId :: Lens' DeregisterTargetFromMaintenanceWindowResponse (Maybe Text) Source #

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

deregisterTargetFromMaintenanceWindowResponse_windowTargetId :: Lens' DeregisterTargetFromMaintenanceWindowResponse (Maybe Text) Source #

The ID of the removed target definition.

deregisterTargetFromMaintenanceWindowResponse_httpStatus :: Lens' DeregisterTargetFromMaintenanceWindowResponse Int Source #

The response's http status code.

DeregisterTaskFromMaintenanceWindow

deregisterTaskFromMaintenanceWindow_windowId :: Lens' DeregisterTaskFromMaintenanceWindow Text Source #

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

deregisterTaskFromMaintenanceWindow_windowTaskId :: Lens' DeregisterTaskFromMaintenanceWindow Text Source #

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

deregisterTaskFromMaintenanceWindowResponse_windowId :: Lens' DeregisterTaskFromMaintenanceWindowResponse (Maybe Text) Source #

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

deregisterTaskFromMaintenanceWindowResponse_windowTaskId :: Lens' DeregisterTaskFromMaintenanceWindowResponse (Maybe Text) Source #

The ID of the task removed from the maintenance window.

deregisterTaskFromMaintenanceWindowResponse_httpStatus :: Lens' DeregisterTaskFromMaintenanceWindowResponse Int Source #

The response's http status code.

DescribeActivations

describeActivations_filters :: Lens' DescribeActivations (Maybe [DescribeActivationsFilter]) Source #

A filter to view information about your activations.

describeActivations_maxResults :: Lens' DescribeActivations (Maybe Natural) Source #

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.

describeActivations_nextToken :: Lens' DescribeActivations (Maybe Text) Source #

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

describeActivationsResponse_activationList :: Lens' DescribeActivationsResponse (Maybe [Activation]) Source #

A list of activations for your Amazon Web Services account.

describeActivationsResponse_nextToken :: Lens' DescribeActivationsResponse (Maybe Text) Source #

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

describeActivationsResponse_httpStatus :: Lens' DescribeActivationsResponse Int Source #

The response's http status code.

DescribeAssociation

describeAssociation_associationId :: Lens' DescribeAssociation (Maybe Text) Source #

The association ID for which you want information.

describeAssociation_associationVersion :: Lens' DescribeAssociation (Maybe Text) Source #

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 a managed node, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

describeAssociation_instanceId :: Lens' DescribeAssociation (Maybe Text) Source #

The managed node ID.

describeAssociation_name :: Lens' DescribeAssociation (Maybe Text) Source #

The name of the SSM document.

describeAssociationResponse_associationDescription :: Lens' DescribeAssociationResponse (Maybe AssociationDescription) Source #

Information about the association.

describeAssociationResponse_httpStatus :: Lens' DescribeAssociationResponse Int Source #

The response's http status code.

DescribeAssociationExecutionTargets

describeAssociationExecutionTargets_filters :: Lens' DescribeAssociationExecutionTargets (Maybe (NonEmpty AssociationExecutionTargetsFilter)) Source #

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

Status (EQUAL)

ResourceId (EQUAL)

ResourceType (EQUAL)

describeAssociationExecutionTargets_maxResults :: Lens' DescribeAssociationExecutionTargets (Maybe Natural) Source #

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.

describeAssociationExecutionTargets_nextToken :: Lens' DescribeAssociationExecutionTargets (Maybe Text) Source #

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

describeAssociationExecutionTargets_associationId :: Lens' DescribeAssociationExecutionTargets Text Source #

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

describeAssociationExecutionTargets_executionId :: Lens' DescribeAssociationExecutionTargets Text Source #

The execution ID for which you want to view details.

describeAssociationExecutionTargetsResponse_associationExecutionTargets :: Lens' DescribeAssociationExecutionTargetsResponse (Maybe [AssociationExecutionTarget]) Source #

Information about the execution.

describeAssociationExecutionTargetsResponse_nextToken :: Lens' DescribeAssociationExecutionTargetsResponse (Maybe Text) Source #

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

describeAssociationExecutionTargetsResponse_httpStatus :: Lens' DescribeAssociationExecutionTargetsResponse Int Source #

The response's http status code.

DescribeAssociationExecutions

describeAssociationExecutions_filters :: Lens' DescribeAssociationExecutions (Maybe (NonEmpty AssociationExecutionFilter)) Source #

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

ExecutionId (EQUAL)

Status (EQUAL)

CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

describeAssociationExecutions_maxResults :: Lens' DescribeAssociationExecutions (Maybe Natural) Source #

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.

describeAssociationExecutions_nextToken :: Lens' DescribeAssociationExecutions (Maybe Text) Source #

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

describeAssociationExecutions_associationId :: Lens' DescribeAssociationExecutions Text Source #

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

describeAssociationExecutionsResponse_associationExecutions :: Lens' DescribeAssociationExecutionsResponse (Maybe [AssociationExecution]) Source #

A list of the executions for the specified association ID.

describeAssociationExecutionsResponse_nextToken :: Lens' DescribeAssociationExecutionsResponse (Maybe Text) Source #

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

describeAssociationExecutionsResponse_httpStatus :: Lens' DescribeAssociationExecutionsResponse Int Source #

The response's http status code.

DescribeAutomationExecutions

describeAutomationExecutions_filters :: Lens' DescribeAutomationExecutions (Maybe (NonEmpty AutomationExecutionFilter)) Source #

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

describeAutomationExecutions_maxResults :: Lens' DescribeAutomationExecutions (Maybe Natural) Source #

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.

describeAutomationExecutions_nextToken :: Lens' DescribeAutomationExecutions (Maybe Text) Source #

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

describeAutomationExecutionsResponse_automationExecutionMetadataList :: Lens' DescribeAutomationExecutionsResponse (Maybe [AutomationExecutionMetadata]) Source #

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

describeAutomationExecutionsResponse_nextToken :: Lens' DescribeAutomationExecutionsResponse (Maybe Text) Source #

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

describeAutomationExecutionsResponse_httpStatus :: Lens' DescribeAutomationExecutionsResponse Int Source #

The response's http status code.

DescribeAutomationStepExecutions

describeAutomationStepExecutions_filters :: Lens' DescribeAutomationStepExecutions (Maybe (NonEmpty StepExecutionFilter)) Source #

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

describeAutomationStepExecutions_maxResults :: Lens' DescribeAutomationStepExecutions (Maybe Natural) Source #

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.

describeAutomationStepExecutions_nextToken :: Lens' DescribeAutomationStepExecutions (Maybe Text) Source #

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

describeAutomationStepExecutions_reverseOrder :: Lens' DescribeAutomationStepExecutions (Maybe Bool) Source #

Indicates whether to list step executions in reverse order by start time. The default value is 'false'.

describeAutomationStepExecutions_automationExecutionId :: Lens' DescribeAutomationStepExecutions Text Source #

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

describeAutomationStepExecutionsResponse_nextToken :: Lens' DescribeAutomationStepExecutionsResponse (Maybe Text) Source #

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

describeAutomationStepExecutionsResponse_stepExecutions :: Lens' DescribeAutomationStepExecutionsResponse (Maybe [StepExecution]) Source #

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

describeAutomationStepExecutionsResponse_httpStatus :: Lens' DescribeAutomationStepExecutionsResponse Int Source #

The response's http status code.

DescribeAvailablePatches

describeAvailablePatches_filters :: Lens' DescribeAvailablePatches (Maybe [PatchOrchestratorFilter]) Source #

Each element in the array is a structure containing a key-value pair.

Windows Server

Supported keys for Windows Server managed node patches include the following:

PATCH_SET
Sample values: OS | APPLICATION
PRODUCT
Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus
PRODUCT_FAMILY
Sample values: Windows | Office
MSRC_SEVERITY
Sample values: ServicePacks | Important | Moderate
CLASSIFICATION
Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates
PATCH_ID
Sample values: KB123456 | KB4516046

Linux

When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the Command Line Interface (CLI), the following command fails:

aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615

However, the following command succeeds:

aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615

Supported keys for Linux managed node patches include the following:

PRODUCT
Sample values: AmazonLinux2018.03 | AmazonLinux2.0
NAME
Sample values: kernel-headers | samba-python | php
SEVERITY
Sample values: Critical | Important | Medium | Low
EPOCH
Sample values: 0 | 1
VERSION
Sample values: 78.6.1 | 4.10.16
RELEASE
Sample values: 9.56.amzn1 | 1.amzn2
ARCH
Sample values: i686 | x86_64
REPOSITORY
Sample values: Core | Updates
ADVISORY_ID
Sample values: ALAS-2018-1058 | ALAS2-2021-1594
CVE_ID
Sample values: CVE-2018-3615 | CVE-2020-1472
BUGZILLA_ID
Sample values: 1463241

describeAvailablePatches_maxResults :: Lens' DescribeAvailablePatches (Maybe Natural) Source #

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

describeAvailablePatches_nextToken :: Lens' DescribeAvailablePatches (Maybe Text) Source #

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

describeAvailablePatchesResponse_nextToken :: Lens' DescribeAvailablePatchesResponse (Maybe Text) Source #

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

describeAvailablePatchesResponse_patches :: Lens' DescribeAvailablePatchesResponse (Maybe [Patch]) Source #

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

describeAvailablePatchesResponse_httpStatus :: Lens' DescribeAvailablePatchesResponse Int Source #

The response's http status code.

DescribeDocument

describeDocument_documentVersion :: Lens' DescribeDocument (Maybe Text) Source #

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

describeDocument_versionName :: Lens' DescribeDocument (Maybe Text) Source #

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

describeDocument_name :: Lens' DescribeDocument Text Source #

The name of the SSM document.

describeDocumentResponse_document :: Lens' DescribeDocumentResponse (Maybe DocumentDescription) Source #

Information about the SSM document.

describeDocumentResponse_httpStatus :: Lens' DescribeDocumentResponse Int Source #

The response's http status code.

DescribeDocumentPermission

describeDocumentPermission_maxResults :: Lens' DescribeDocumentPermission (Maybe Natural) Source #

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.

describeDocumentPermission_nextToken :: Lens' DescribeDocumentPermission (Maybe Text) Source #

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

describeDocumentPermission_name :: Lens' DescribeDocumentPermission Text Source #

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

describeDocumentPermission_permissionType :: Lens' DescribeDocumentPermission DocumentPermissionType Source #

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

describeDocumentPermissionResponse_accountIds :: Lens' DescribeDocumentPermissionResponse (Maybe [Text]) Source #

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

describeDocumentPermissionResponse_accountSharingInfoList :: Lens' DescribeDocumentPermissionResponse (Maybe [AccountSharingInfo]) Source #

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

describeDocumentPermissionResponse_nextToken :: Lens' DescribeDocumentPermissionResponse (Maybe Text) Source #

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

describeDocumentPermissionResponse_httpStatus :: Lens' DescribeDocumentPermissionResponse Int Source #

The response's http status code.

DescribeEffectiveInstanceAssociations

describeEffectiveInstanceAssociations_maxResults :: Lens' DescribeEffectiveInstanceAssociations (Maybe Natural) Source #

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.

describeEffectiveInstanceAssociations_nextToken :: Lens' DescribeEffectiveInstanceAssociations (Maybe Text) Source #

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

describeEffectiveInstanceAssociations_instanceId :: Lens' DescribeEffectiveInstanceAssociations Text Source #

The managed node ID for which you want to view all associations.

describeEffectiveInstanceAssociationsResponse_associations :: Lens' DescribeEffectiveInstanceAssociationsResponse (Maybe [InstanceAssociation]) Source #

The associations for the requested managed node.

describeEffectiveInstanceAssociationsResponse_nextToken :: Lens' DescribeEffectiveInstanceAssociationsResponse (Maybe Text) Source #

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

describeEffectiveInstanceAssociationsResponse_httpStatus :: Lens' DescribeEffectiveInstanceAssociationsResponse Int Source #

The response's http status code.

DescribeEffectivePatchesForPatchBaseline

describeEffectivePatchesForPatchBaseline_maxResults :: Lens' DescribeEffectivePatchesForPatchBaseline (Maybe Natural) Source #

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

describeEffectivePatchesForPatchBaseline_nextToken :: Lens' DescribeEffectivePatchesForPatchBaseline (Maybe Text) Source #

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

describeEffectivePatchesForPatchBaseline_baselineId :: Lens' DescribeEffectivePatchesForPatchBaseline Text Source #

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

describeEffectivePatchesForPatchBaselineResponse_effectivePatches :: Lens' DescribeEffectivePatchesForPatchBaselineResponse (Maybe [EffectivePatch]) Source #

An array of patches and patch status.

describeEffectivePatchesForPatchBaselineResponse_nextToken :: Lens' DescribeEffectivePatchesForPatchBaselineResponse (Maybe Text) Source #

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

describeEffectivePatchesForPatchBaselineResponse_httpStatus :: Lens' DescribeEffectivePatchesForPatchBaselineResponse Int Source #

The response's http status code.

DescribeInstanceAssociationsStatus

describeInstanceAssociationsStatus_maxResults :: Lens' DescribeInstanceAssociationsStatus (Maybe Natural) Source #

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.

describeInstanceAssociationsStatus_nextToken :: Lens' DescribeInstanceAssociationsStatus (Maybe Text) Source #

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

describeInstanceAssociationsStatus_instanceId :: Lens' DescribeInstanceAssociationsStatus Text Source #

The managed node IDs for which you want association status information.

describeInstanceAssociationsStatusResponse_instanceAssociationStatusInfos :: Lens' DescribeInstanceAssociationsStatusResponse (Maybe [InstanceAssociationStatusInfo]) Source #

Status information about the association.

describeInstanceAssociationsStatusResponse_nextToken :: Lens' DescribeInstanceAssociationsStatusResponse (Maybe Text) Source #

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

describeInstanceAssociationsStatusResponse_httpStatus :: Lens' DescribeInstanceAssociationsStatusResponse Int Source #

The response's http status code.

DescribeInstanceInformation

describeInstanceInformation_filters :: Lens' DescribeInstanceInformation (Maybe [InstanceInformationStringFilter]) Source #

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

describeInstanceInformation_instanceInformationFilterList :: Lens' DescribeInstanceInformation (Maybe [InstanceInformationFilter]) Source #

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

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

describeInstanceInformation_maxResults :: Lens' DescribeInstanceInformation (Maybe Natural) Source #

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.

describeInstanceInformation_nextToken :: Lens' DescribeInstanceInformation (Maybe Text) Source #

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

describeInstanceInformationResponse_instanceInformationList :: Lens' DescribeInstanceInformationResponse (Maybe [InstanceInformation]) Source #

The managed node information list.

describeInstanceInformationResponse_nextToken :: Lens' DescribeInstanceInformationResponse (Maybe Text) Source #

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

describeInstanceInformationResponse_httpStatus :: Lens' DescribeInstanceInformationResponse Int Source #

The response's http status code.

DescribeInstancePatchStates

describeInstancePatchStates_maxResults :: Lens' DescribeInstancePatchStates (Maybe Natural) Source #

The maximum number of managed nodes to return (per page).

describeInstancePatchStates_nextToken :: Lens' DescribeInstancePatchStates (Maybe Text) Source #

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

describeInstancePatchStates_instanceIds :: Lens' DescribeInstancePatchStates [Text] Source #

The ID of the managed node for which patch state information should be retrieved.

describeInstancePatchStatesResponse_instancePatchStates :: Lens' DescribeInstancePatchStatesResponse (Maybe [InstancePatchState]) Source #

The high-level patch state for the requested managed nodes.

describeInstancePatchStatesResponse_nextToken :: Lens' DescribeInstancePatchStatesResponse (Maybe Text) Source #

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

describeInstancePatchStatesResponse_httpStatus :: Lens' DescribeInstancePatchStatesResponse Int Source #

The response's http status code.

DescribeInstancePatchStatesForPatchGroup

describeInstancePatchStatesForPatchGroup_filters :: Lens' DescribeInstancePatchStatesForPatchGroup (Maybe [InstancePatchStateFilter]) Source #

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

describeInstancePatchStatesForPatchGroup_maxResults :: Lens' DescribeInstancePatchStatesForPatchGroup (Maybe Natural) Source #

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

describeInstancePatchStatesForPatchGroup_nextToken :: Lens' DescribeInstancePatchStatesForPatchGroup (Maybe Text) Source #

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

describeInstancePatchStatesForPatchGroup_patchGroup :: Lens' DescribeInstancePatchStatesForPatchGroup Text Source #

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

describeInstancePatchStatesForPatchGroupResponse_instancePatchStates :: Lens' DescribeInstancePatchStatesForPatchGroupResponse (Maybe (NonEmpty InstancePatchState)) Source #

The high-level patch state for the requested managed nodes.

describeInstancePatchStatesForPatchGroupResponse_nextToken :: Lens' DescribeInstancePatchStatesForPatchGroupResponse (Maybe Text) Source #

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

describeInstancePatchStatesForPatchGroupResponse_httpStatus :: Lens' DescribeInstancePatchStatesForPatchGroupResponse Int Source #

The response's http status code.

DescribeInstancePatches

describeInstancePatches_filters :: Lens' DescribeInstancePatches (Maybe [PatchOrchestratorFilter]) Source #

Each element in the array is a structure containing a key-value pair.

Supported keys for DescribeInstancePatchesinclude the following:

Classification
Sample values: Security | SecurityUpdates
KBId
Sample values: KB4480056 | java-1.7.0-openjdk.x86_64
Severity
Sample values: Important | Medium | Low
State
Sample values: Installed | InstalledOther | InstalledPendingReboot

describeInstancePatches_maxResults :: Lens' DescribeInstancePatches (Maybe Natural) Source #

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

describeInstancePatches_nextToken :: Lens' DescribeInstancePatches (Maybe Text) Source #

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

describeInstancePatches_instanceId :: Lens' DescribeInstancePatches Text Source #

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

describeInstancePatchesResponse_nextToken :: Lens' DescribeInstancePatchesResponse (Maybe Text) Source #

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

describeInstancePatchesResponse_patches :: Lens' DescribeInstancePatchesResponse (Maybe [PatchComplianceData]) Source #

Each entry in the array is a structure containing:

Title (string)
KBId (string)
Classification (string)
Severity (string)
State (string, such as "INSTALLED" or "FAILED")
InstalledTime (DateTime)
InstalledBy (string)

describeInstancePatchesResponse_httpStatus :: Lens' DescribeInstancePatchesResponse Int Source #

The response's http status code.

DescribeInventoryDeletions

describeInventoryDeletions_deletionId :: Lens' DescribeInventoryDeletions (Maybe Text) Source #

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

describeInventoryDeletions_maxResults :: Lens' DescribeInventoryDeletions (Maybe Natural) Source #

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.

describeInventoryDeletions_nextToken :: Lens' DescribeInventoryDeletions (Maybe Text) Source #

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

describeInventoryDeletionsResponse_inventoryDeletions :: Lens' DescribeInventoryDeletionsResponse (Maybe [InventoryDeletionStatusItem]) Source #

A list of status items for deleted inventory.

describeInventoryDeletionsResponse_nextToken :: Lens' DescribeInventoryDeletionsResponse (Maybe Text) Source #

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

describeInventoryDeletionsResponse_httpStatus :: Lens' DescribeInventoryDeletionsResponse Int Source #

The response's http status code.

DescribeMaintenanceWindowExecutionTaskInvocations

describeMaintenanceWindowExecutionTaskInvocations_filters :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations (Maybe [MaintenanceWindowFilter]) Source #

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.

describeMaintenanceWindowExecutionTaskInvocations_maxResults :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations (Maybe Natural) Source #

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.

describeMaintenanceWindowExecutionTaskInvocations_nextToken :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations (Maybe Text) Source #

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

describeMaintenanceWindowExecutionTaskInvocations_windowExecutionId :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations Text Source #

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

describeMaintenanceWindowExecutionTaskInvocations_taskId :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations Text Source #

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

describeMaintenanceWindowExecutionTaskInvocationsResponse_nextToken :: Lens' DescribeMaintenanceWindowExecutionTaskInvocationsResponse (Maybe Text) Source #

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

describeMaintenanceWindowExecutionTaskInvocationsResponse_windowExecutionTaskInvocationIdentities :: Lens' DescribeMaintenanceWindowExecutionTaskInvocationsResponse (Maybe [MaintenanceWindowExecutionTaskInvocationIdentity]) Source #

Information about the task invocation results per invocation.

describeMaintenanceWindowExecutionTaskInvocationsResponse_httpStatus :: Lens' DescribeMaintenanceWindowExecutionTaskInvocationsResponse Int Source #

The response's http status code.

DescribeMaintenanceWindowExecutionTasks

describeMaintenanceWindowExecutionTasks_filters :: Lens' DescribeMaintenanceWindowExecutionTasks (Maybe [MaintenanceWindowFilter]) Source #

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.

describeMaintenanceWindowExecutionTasks_maxResults :: Lens' DescribeMaintenanceWindowExecutionTasks (Maybe Natural) Source #

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.

describeMaintenanceWindowExecutionTasks_nextToken :: Lens' DescribeMaintenanceWindowExecutionTasks (Maybe Text) Source #

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

describeMaintenanceWindowExecutionTasks_windowExecutionId :: Lens' DescribeMaintenanceWindowExecutionTasks Text Source #

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

describeMaintenanceWindowExecutionTasksResponse_nextToken :: Lens' DescribeMaintenanceWindowExecutionTasksResponse (Maybe Text) Source #

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

describeMaintenanceWindowExecutionTasksResponse_windowExecutionTaskIdentities :: Lens' DescribeMaintenanceWindowExecutionTasksResponse (Maybe [MaintenanceWindowExecutionTaskIdentity]) Source #

Information about the task executions.

describeMaintenanceWindowExecutionTasksResponse_httpStatus :: Lens' DescribeMaintenanceWindowExecutionTasksResponse Int Source #

The response's http status code.

DescribeMaintenanceWindowExecutions

describeMaintenanceWindowExecutions_filters :: Lens' DescribeMaintenanceWindowExecutions (Maybe [MaintenanceWindowFilter]) Source #

Each entry in the array is a structure containing:

Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter.
Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2021-11-04T05:00:00Z.

describeMaintenanceWindowExecutions_maxResults :: Lens' DescribeMaintenanceWindowExecutions (Maybe Natural) Source #

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.

describeMaintenanceWindowExecutions_nextToken :: Lens' DescribeMaintenanceWindowExecutions (Maybe Text) Source #

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

describeMaintenanceWindowExecutions_windowId :: Lens' DescribeMaintenanceWindowExecutions Text Source #

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

describeMaintenanceWindowExecutionsResponse_nextToken :: Lens' DescribeMaintenanceWindowExecutionsResponse (Maybe Text) Source #

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

describeMaintenanceWindowExecutionsResponse_windowExecutions :: Lens' DescribeMaintenanceWindowExecutionsResponse (Maybe [MaintenanceWindowExecution]) Source #

Information about the maintenance window executions.

describeMaintenanceWindowExecutionsResponse_httpStatus :: Lens' DescribeMaintenanceWindowExecutionsResponse Int Source #

The response's http status code.

DescribeMaintenanceWindowSchedule

describeMaintenanceWindowSchedule_filters :: Lens' DescribeMaintenanceWindowSchedule (Maybe [PatchOrchestratorFilter]) Source #

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

describeMaintenanceWindowSchedule_maxResults :: Lens' DescribeMaintenanceWindowSchedule (Maybe Natural) Source #

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.

describeMaintenanceWindowSchedule_nextToken :: Lens' DescribeMaintenanceWindowSchedule (Maybe Text) Source #

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

describeMaintenanceWindowSchedule_resourceType :: Lens' DescribeMaintenanceWindowSchedule (Maybe MaintenanceWindowResourceType) Source #

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

describeMaintenanceWindowSchedule_targets :: Lens' DescribeMaintenanceWindowSchedule (Maybe [Target]) Source #

The managed node ID or key-value pair to retrieve information about.

describeMaintenanceWindowSchedule_windowId :: Lens' DescribeMaintenanceWindowSchedule (Maybe Text) Source #

The ID of the maintenance window to retrieve information about.

describeMaintenanceWindowScheduleResponse_nextToken :: Lens' DescribeMaintenanceWindowScheduleResponse (Maybe Text) Source #

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

describeMaintenanceWindowScheduleResponse_scheduledWindowExecutions :: Lens' DescribeMaintenanceWindowScheduleResponse (Maybe [ScheduledWindowExecution]) Source #

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

describeMaintenanceWindowScheduleResponse_httpStatus :: Lens' DescribeMaintenanceWindowScheduleResponse Int Source #

The response's http status code.

DescribeMaintenanceWindowTargets

describeMaintenanceWindowTargets_filters :: Lens' DescribeMaintenanceWindowTargets (Maybe [MaintenanceWindowFilter]) Source #

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.

describeMaintenanceWindowTargets_maxResults :: Lens' DescribeMaintenanceWindowTargets (Maybe Natural) Source #

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.

describeMaintenanceWindowTargets_nextToken :: Lens' DescribeMaintenanceWindowTargets (Maybe Text) Source #

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

describeMaintenanceWindowTargets_windowId :: Lens' DescribeMaintenanceWindowTargets Text Source #

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

describeMaintenanceWindowTargetsResponse_nextToken :: Lens' DescribeMaintenanceWindowTargetsResponse (Maybe Text) Source #

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

describeMaintenanceWindowTargetsResponse_targets :: Lens' DescribeMaintenanceWindowTargetsResponse (Maybe [MaintenanceWindowTarget]) Source #

Information about the targets in the maintenance window.

describeMaintenanceWindowTargetsResponse_httpStatus :: Lens' DescribeMaintenanceWindowTargetsResponse Int Source #

The response's http status code.

DescribeMaintenanceWindowTasks

describeMaintenanceWindowTasks_filters :: Lens' DescribeMaintenanceWindowTasks (Maybe [MaintenanceWindowFilter]) Source #

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

describeMaintenanceWindowTasks_maxResults :: Lens' DescribeMaintenanceWindowTasks (Maybe Natural) Source #

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.

describeMaintenanceWindowTasks_nextToken :: Lens' DescribeMaintenanceWindowTasks (Maybe Text) Source #

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

describeMaintenanceWindowTasks_windowId :: Lens' DescribeMaintenanceWindowTasks Text Source #

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

describeMaintenanceWindowTasksResponse_nextToken :: Lens' DescribeMaintenanceWindowTasksResponse (Maybe Text) Source #

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

describeMaintenanceWindowTasksResponse_tasks :: Lens' DescribeMaintenanceWindowTasksResponse (Maybe [MaintenanceWindowTask]) Source #

Information about the tasks in the maintenance window.

describeMaintenanceWindowTasksResponse_httpStatus :: Lens' DescribeMaintenanceWindowTasksResponse Int Source #

The response's http status code.

DescribeMaintenanceWindows

describeMaintenanceWindows_filters :: Lens' DescribeMaintenanceWindows (Maybe [MaintenanceWindowFilter]) Source #

Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled. For example, Name=MyMaintenanceWindow and Enabled=True.

describeMaintenanceWindows_maxResults :: Lens' DescribeMaintenanceWindows (Maybe Natural) Source #

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.

describeMaintenanceWindows_nextToken :: Lens' DescribeMaintenanceWindows (Maybe Text) Source #

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

describeMaintenanceWindowsResponse_nextToken :: Lens' DescribeMaintenanceWindowsResponse (Maybe Text) Source #

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

describeMaintenanceWindowsResponse_windowIdentities :: Lens' DescribeMaintenanceWindowsResponse (Maybe [MaintenanceWindowIdentity]) Source #

Information about the maintenance windows.

describeMaintenanceWindowsResponse_httpStatus :: Lens' DescribeMaintenanceWindowsResponse Int Source #

The response's http status code.

DescribeMaintenanceWindowsForTarget

describeMaintenanceWindowsForTarget_maxResults :: Lens' DescribeMaintenanceWindowsForTarget (Maybe Natural) Source #

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.

describeMaintenanceWindowsForTarget_nextToken :: Lens' DescribeMaintenanceWindowsForTarget (Maybe Text) Source #

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

describeMaintenanceWindowsForTarget_targets :: Lens' DescribeMaintenanceWindowsForTarget [Target] Source #

The managed node ID or key-value pair to retrieve information about.

describeMaintenanceWindowsForTarget_resourceType :: Lens' DescribeMaintenanceWindowsForTarget MaintenanceWindowResourceType Source #

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

describeMaintenanceWindowsForTargetResponse_nextToken :: Lens' DescribeMaintenanceWindowsForTargetResponse (Maybe Text) Source #

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

describeMaintenanceWindowsForTargetResponse_windowIdentities :: Lens' DescribeMaintenanceWindowsForTargetResponse (Maybe [MaintenanceWindowIdentityForTarget]) Source #

Information about the maintenance window targets and tasks a managed node is associated with.

describeMaintenanceWindowsForTargetResponse_httpStatus :: Lens' DescribeMaintenanceWindowsForTargetResponse Int Source #

The response's http status code.

DescribeOpsItems

describeOpsItems_maxResults :: Lens' DescribeOpsItems (Maybe Natural) Source #

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.

describeOpsItems_nextToken :: Lens' DescribeOpsItems (Maybe Text) Source #

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

describeOpsItems_opsItemFilters :: Lens' DescribeOpsItems (Maybe [OpsItemFilter]) Source #

One or more filters to limit the response.

Key: CreatedTime
Operations: GreaterThan, LessThan
Key: LastModifiedBy
Operations: Contains, Equals
Key: LastModifiedTime
Operations: GreaterThan, LessThan
Key: Priority
Operations: Equals
Key: Source
Operations: Contains, Equals
Key: Status
Operations: Equals
Key: Title*
Operations: Equals,Contains
Key: OperationalData**
Operations: Equals
Key: OperationalDataKey
Operations: Equals
Key: OperationalDataValue
Operations: Equals, Contains
Key: OpsItemId
Operations: Equals
Key: ResourceId
Operations: Contains
Key: AutomationId
Operations: Equals
The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.
*If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

describeOpsItemsResponse_nextToken :: Lens' DescribeOpsItemsResponse (Maybe Text) Source #

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

describeOpsItemsResponse_opsItemSummaries :: Lens' DescribeOpsItemsResponse (Maybe [OpsItemSummary]) Source #

A list of OpsItems.

describeOpsItemsResponse_httpStatus :: Lens' DescribeOpsItemsResponse Int Source #

The response's http status code.

DescribeParameters

describeParameters_filters :: Lens' DescribeParameters (Maybe [ParametersFilter]) Source #

This data type is deprecated. Instead, use ParameterFilters.

describeParameters_maxResults :: Lens' DescribeParameters (Maybe Natural) Source #

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.

describeParameters_nextToken :: Lens' DescribeParameters (Maybe Text) Source #

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

describeParameters_parameterFilters :: Lens' DescribeParameters (Maybe [ParameterStringFilter]) Source #

Filters to limit the request results.

describeParametersResponse_nextToken :: Lens' DescribeParametersResponse (Maybe Text) Source #

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

describeParametersResponse_parameters :: Lens' DescribeParametersResponse (Maybe [ParameterMetadata]) Source #

Parameters returned by the request.

describeParametersResponse_httpStatus :: Lens' DescribeParametersResponse Int Source #

The response's http status code.

DescribePatchBaselines

describePatchBaselines_filters :: Lens' DescribePatchBaselines (Maybe [PatchOrchestratorFilter]) Source #

Each element in the array is a structure containing a key-value pair.

Supported keys for DescribePatchBaselines include the following:

NAME_PREFIX
Sample values: AWS- | My-
OWNER
Sample values: AWS | Self
OPERATING_SYSTEM
Sample values: AMAZON_LINUX | SUSE | WINDOWS

describePatchBaselines_maxResults :: Lens' DescribePatchBaselines (Maybe Natural) Source #

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

describePatchBaselines_nextToken :: Lens' DescribePatchBaselines (Maybe Text) Source #

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

describePatchBaselinesResponse_baselineIdentities :: Lens' DescribePatchBaselinesResponse (Maybe [PatchBaselineIdentity]) Source #

An array of PatchBaselineIdentity elements.

describePatchBaselinesResponse_nextToken :: Lens' DescribePatchBaselinesResponse (Maybe Text) Source #

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

describePatchBaselinesResponse_httpStatus :: Lens' DescribePatchBaselinesResponse Int Source #

The response's http status code.

DescribePatchGroupState

describePatchGroupState_patchGroup :: Lens' DescribePatchGroupState Text Source #

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

describePatchGroupStateResponse_instances :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes in the patch group.

describePatchGroupStateResponse_instancesWithCriticalNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

describePatchGroupStateResponse_instancesWithFailedPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

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

describePatchGroupStateResponse_instancesWithInstalledOtherPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

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

describePatchGroupStateResponse_instancesWithInstalledPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes with installed patches.

describePatchGroupStateResponse_instancesWithInstalledPendingRebootPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these managed nodes is NON_COMPLIANT.

describePatchGroupStateResponse_instancesWithInstalledRejectedPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

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

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

describePatchGroupStateResponse_instancesWithMissingPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes with missing patches from the patch baseline.

describePatchGroupStateResponse_instancesWithNotApplicablePatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes with patches that aren't applicable.

describePatchGroupStateResponse_instancesWithOtherNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT.

describePatchGroupStateResponse_instancesWithSecurityNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes where patches that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

describePatchGroupStateResponse_instancesWithUnreportedNotApplicablePatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

describePatchGroupStateResponse_httpStatus :: Lens' DescribePatchGroupStateResponse Int Source #

The response's http status code.

DescribePatchGroups

describePatchGroups_filters :: Lens' DescribePatchGroups (Maybe [PatchOrchestratorFilter]) Source #

Each element in the array is a structure containing a key-value pair.

Supported keys for DescribePatchGroups include the following:

NAME_PREFIX
Sample values: AWS- | My-.
OPERATING_SYSTEM
Sample values: AMAZON_LINUX | SUSE | WINDOWS

describePatchGroups_maxResults :: Lens' DescribePatchGroups (Maybe Natural) Source #

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

describePatchGroups_nextToken :: Lens' DescribePatchGroups (Maybe Text) Source #

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

describePatchGroupsResponse_mappings :: Lens' DescribePatchGroupsResponse (Maybe [PatchGroupPatchBaselineMapping]) Source #

Each entry in the array contains:

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

describePatchGroupsResponse_nextToken :: Lens' DescribePatchGroupsResponse (Maybe Text) Source #

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

describePatchGroupsResponse_httpStatus :: Lens' DescribePatchGroupsResponse Int Source #

The response's http status code.

DescribePatchProperties

describePatchProperties_maxResults :: Lens' DescribePatchProperties (Maybe Natural) Source #

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.

describePatchProperties_nextToken :: Lens' DescribePatchProperties (Maybe Text) Source #

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

describePatchProperties_patchSet :: Lens' DescribePatchProperties (Maybe PatchSet) Source #

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

describePatchProperties_operatingSystem :: Lens' DescribePatchProperties OperatingSystem Source #

The operating system type for which to list patches.

describePatchProperties_property :: Lens' DescribePatchProperties PatchProperty Source #

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

describePatchPropertiesResponse_nextToken :: Lens' DescribePatchPropertiesResponse (Maybe Text) Source #

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

describePatchPropertiesResponse_properties :: Lens' DescribePatchPropertiesResponse (Maybe [HashMap Text Text]) Source #

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

describePatchPropertiesResponse_httpStatus :: Lens' DescribePatchPropertiesResponse Int Source #

The response's http status code.

DescribeSessions

describeSessions_filters :: Lens' DescribeSessions (Maybe (NonEmpty SessionFilter)) Source #

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

describeSessions_maxResults :: Lens' DescribeSessions (Maybe Natural) Source #

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.

describeSessions_nextToken :: Lens' DescribeSessions (Maybe Text) Source #

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

describeSessions_state :: Lens' DescribeSessions SessionState Source #

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

describeSessionsResponse_nextToken :: Lens' DescribeSessionsResponse (Maybe Text) Source #

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

describeSessionsResponse_sessions :: Lens' DescribeSessionsResponse (Maybe [Session]) Source #

A list of sessions meeting the request parameters.

describeSessionsResponse_httpStatus :: Lens' DescribeSessionsResponse Int Source #

The response's http status code.

DisassociateOpsItemRelatedItem

disassociateOpsItemRelatedItem_opsItemId :: Lens' DisassociateOpsItemRelatedItem Text Source #

The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item.

disassociateOpsItemRelatedItem_associationId :: Lens' DisassociateOpsItemRelatedItem Text Source #

The ID of the association for which you want to delete an association between the OpsItem and a related item.

disassociateOpsItemRelatedItemResponse_httpStatus :: Lens' DisassociateOpsItemRelatedItemResponse Int Source #

The response's http status code.

GetAutomationExecution

getAutomationExecution_automationExecutionId :: Lens' GetAutomationExecution Text Source #

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

getAutomationExecutionResponse_automationExecution :: Lens' GetAutomationExecutionResponse (Maybe AutomationExecution) Source #

Detailed information about the current state of an automation execution.

getAutomationExecutionResponse_httpStatus :: Lens' GetAutomationExecutionResponse Int Source #

The response's http status code.

GetCalendarState

getCalendarState_atTime :: Lens' GetCalendarState (Maybe Text) Source #

(Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you don't specify a value or AtTime, the current time is used.

getCalendarState_calendarNames :: Lens' GetCalendarState [Text] Source #

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

getCalendarStateResponse_atTime :: Lens' GetCalendarStateResponse (Maybe Text) Source #

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

getCalendarStateResponse_nextTransitionTime :: Lens' GetCalendarStateResponse (Maybe Text) Source #

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

getCalendarStateResponse_state :: Lens' GetCalendarStateResponse (Maybe CalendarState) Source #

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

getCalendarStateResponse_httpStatus :: Lens' GetCalendarStateResponse Int Source #

The response's http status code.

GetCommandInvocation

getCommandInvocation_pluginName :: Lens' GetCommandInvocation (Maybe Text) Source #

The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like aws:RunShellScript.

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

getCommandInvocation_commandId :: Lens' GetCommandInvocation Text Source #

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

getCommandInvocation_instanceId :: Lens' GetCommandInvocation Text Source #

(Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

getCommandInvocationResponse_cloudWatchOutputConfig :: Lens' GetCommandInvocationResponse (Maybe CloudWatchOutputConfig) Source #

Amazon CloudWatch Logs information where Systems Manager sent the command output.

getCommandInvocationResponse_commandId :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

The parent command ID of the invocation plugin.

getCommandInvocationResponse_comment :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

The comment text for the command.

getCommandInvocationResponse_documentName :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

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

getCommandInvocationResponse_documentVersion :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

The Systems Manager document (SSM document) version used in the request.

getCommandInvocationResponse_executionElapsedTime :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

Duration since ExecutionStartDateTime.

getCommandInvocationResponse_executionEndDateTime :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

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

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

If the plugin hasn't started to run, the string is empty.

getCommandInvocationResponse_executionStartDateTime :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

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

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

If the plugin hasn't started to run, the string is empty.

getCommandInvocationResponse_instanceId :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

getCommandInvocationResponse_pluginName :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

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

getCommandInvocationResponse_responseCode :: Lens' GetCommandInvocationResponse (Maybe Int) Source #

The error level response code for the plugin script. If the response code is -1, then the command hasn't started running on the managed node, or it wasn't received by the node.

getCommandInvocationResponse_standardErrorContent :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

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

getCommandInvocationResponse_standardErrorUrl :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

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

getCommandInvocationResponse_standardOutputContent :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

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

getCommandInvocationResponse_standardOutputUrl :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

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

getCommandInvocationResponse_status :: Lens' GetCommandInvocationResponse (Maybe CommandInvocationStatus) Source #

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

getCommandInvocationResponse_statusDetails :: Lens' GetCommandInvocationResponse (Maybe Text) Source #

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

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

getCommandInvocationResponse_httpStatus :: Lens' GetCommandInvocationResponse Int Source #

The response's http status code.

GetConnectionStatus

getConnectionStatus_target :: Lens' GetConnectionStatus Text Source #

The managed node ID.

getConnectionStatusResponse_status :: Lens' GetConnectionStatusResponse (Maybe ConnectionStatus) Source #

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

getConnectionStatusResponse_target :: Lens' GetConnectionStatusResponse (Maybe Text) Source #

The ID of the managed node to check connection status.

getConnectionStatusResponse_httpStatus :: Lens' GetConnectionStatusResponse Int Source #

The response's http status code.

GetDefaultPatchBaseline

getDefaultPatchBaseline_operatingSystem :: Lens' GetDefaultPatchBaseline (Maybe OperatingSystem) Source #

Returns the default patch baseline for the specified operating system.

getDefaultPatchBaselineResponse_baselineId :: Lens' GetDefaultPatchBaselineResponse (Maybe Text) Source #

The ID of the default patch baseline.

getDefaultPatchBaselineResponse_operatingSystem :: Lens' GetDefaultPatchBaselineResponse (Maybe OperatingSystem) Source #

The operating system for the returned patch baseline.

getDefaultPatchBaselineResponse_httpStatus :: Lens' GetDefaultPatchBaselineResponse Int Source #

The response's http status code.

GetDeployablePatchSnapshotForInstance

getDeployablePatchSnapshotForInstance_baselineOverride :: Lens' GetDeployablePatchSnapshotForInstance (Maybe BaselineOverride) Source #

Defines the basic information about a patch baseline override.

getDeployablePatchSnapshotForInstance_instanceId :: Lens' GetDeployablePatchSnapshotForInstance Text Source #

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

getDeployablePatchSnapshotForInstance_snapshotId :: Lens' GetDeployablePatchSnapshotForInstance Text Source #

The snapshot ID provided by the user when running AWS-RunPatchBaseline.

getDeployablePatchSnapshotForInstanceResponse_instanceId :: Lens' GetDeployablePatchSnapshotForInstanceResponse (Maybe Text) Source #

The managed node ID.

getDeployablePatchSnapshotForInstanceResponse_product :: Lens' GetDeployablePatchSnapshotForInstanceResponse (Maybe Text) Source #

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

getDeployablePatchSnapshotForInstanceResponse_snapshotDownloadUrl :: Lens' GetDeployablePatchSnapshotForInstanceResponse (Maybe Text) Source #

A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.

getDeployablePatchSnapshotForInstanceResponse_snapshotId :: Lens' GetDeployablePatchSnapshotForInstanceResponse (Maybe Text) Source #

The user-defined snapshot ID.

getDeployablePatchSnapshotForInstanceResponse_httpStatus :: Lens' GetDeployablePatchSnapshotForInstanceResponse Int Source #

The response's http status code.

GetDocument

getDocument_documentFormat :: Lens' GetDocument (Maybe DocumentFormat) Source #

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

getDocument_documentVersion :: Lens' GetDocument (Maybe Text) Source #

The document version for which you want information.

getDocument_versionName :: Lens' GetDocument (Maybe Text) Source #

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

getDocument_name :: Lens' GetDocument Text Source #

The name of the SSM document.

getDocumentResponse_attachmentsContent :: Lens' GetDocumentResponse (Maybe [AttachmentContent]) Source #

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

getDocumentResponse_content :: Lens' GetDocumentResponse (Maybe Text) Source #

The contents of the SSM document.

getDocumentResponse_createdDate :: Lens' GetDocumentResponse (Maybe UTCTime) Source #

The date the SSM document was created.

getDocumentResponse_displayName :: Lens' GetDocumentResponse (Maybe Text) Source #

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

getDocumentResponse_documentFormat :: Lens' GetDocumentResponse (Maybe DocumentFormat) Source #

The document format, either JSON or YAML.

getDocumentResponse_documentType :: Lens' GetDocumentResponse (Maybe DocumentType) Source #

The document type.

getDocumentResponse_documentVersion :: Lens' GetDocumentResponse (Maybe Text) Source #

The document version.

getDocumentResponse_name :: Lens' GetDocumentResponse (Maybe Text) Source #

The name of the SSM document.

getDocumentResponse_requires :: Lens' GetDocumentResponse (Maybe (NonEmpty DocumentRequires)) Source #

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

getDocumentResponse_reviewStatus :: Lens' GetDocumentResponse (Maybe ReviewStatus) Source #

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

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

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

getDocumentResponse_status :: Lens' GetDocumentResponse (Maybe DocumentStatus) Source #

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

getDocumentResponse_statusInformation :: Lens' GetDocumentResponse (Maybe Text) Source #

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

getDocumentResponse_versionName :: Lens' GetDocumentResponse (Maybe Text) Source #

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

getDocumentResponse_httpStatus :: Lens' GetDocumentResponse Int Source #

The response's http status code.

GetInventory

getInventory_aggregators :: Lens' GetInventory (Maybe (NonEmpty InventoryAggregator)) Source #

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

getInventory_filters :: Lens' GetInventory (Maybe (NonEmpty InventoryFilter)) Source #

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

getInventory_maxResults :: Lens' GetInventory (Maybe Natural) Source #

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.

getInventory_nextToken :: Lens' GetInventory (Maybe Text) Source #

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

getInventory_resultAttributes :: Lens' GetInventory (Maybe (NonEmpty ResultAttribute)) Source #

The list of inventory item types to return.

getInventoryResponse_entities :: Lens' GetInventoryResponse (Maybe [InventoryResultEntity]) Source #

Collection of inventory entities such as a collection of managed node inventory.

getInventoryResponse_nextToken :: Lens' GetInventoryResponse (Maybe Text) Source #

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

getInventoryResponse_httpStatus :: Lens' GetInventoryResponse Int Source #

The response's http status code.

GetInventorySchema

getInventorySchema_aggregator :: Lens' GetInventorySchema (Maybe Bool) Source #

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

getInventorySchema_maxResults :: Lens' GetInventorySchema (Maybe Natural) Source #

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.

getInventorySchema_nextToken :: Lens' GetInventorySchema (Maybe Text) Source #

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

getInventorySchema_subType :: Lens' GetInventorySchema (Maybe Bool) Source #

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

getInventorySchema_typeName :: Lens' GetInventorySchema (Maybe Text) Source #

The type of inventory item to return.

getInventorySchemaResponse_nextToken :: Lens' GetInventorySchemaResponse (Maybe Text) Source #

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

getInventorySchemaResponse_schemas :: Lens' GetInventorySchemaResponse (Maybe [InventoryItemSchema]) Source #

Inventory schemas returned by the request.

getInventorySchemaResponse_httpStatus :: Lens' GetInventorySchemaResponse Int Source #

The response's http status code.

GetMaintenanceWindow

getMaintenanceWindow_windowId :: Lens' GetMaintenanceWindow Text Source #

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

getMaintenanceWindowResponse_allowUnassociatedTargets :: Lens' GetMaintenanceWindowResponse (Maybe Bool) Source #

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

getMaintenanceWindowResponse_createdDate :: Lens' GetMaintenanceWindowResponse (Maybe UTCTime) Source #

The date the maintenance window was created.

getMaintenanceWindowResponse_cutoff :: Lens' GetMaintenanceWindowResponse (Maybe Natural) Source #

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

getMaintenanceWindowResponse_description :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The description of the maintenance window.

getMaintenanceWindowResponse_duration :: Lens' GetMaintenanceWindowResponse (Maybe Natural) Source #

The duration of the maintenance window in hours.

getMaintenanceWindowResponse_enabled :: Lens' GetMaintenanceWindowResponse (Maybe Bool) Source #

Indicates whether the maintenance window is enabled.

getMaintenanceWindowResponse_endDate :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

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

getMaintenanceWindowResponse_modifiedDate :: Lens' GetMaintenanceWindowResponse (Maybe UTCTime) Source #

The date the maintenance window was last modified.

getMaintenanceWindowResponse_name :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The name of the maintenance window.

getMaintenanceWindowResponse_nextExecutionTime :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

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

getMaintenanceWindowResponse_schedule :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

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

getMaintenanceWindowResponse_scheduleOffset :: Lens' GetMaintenanceWindowResponse (Maybe Natural) Source #

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

getMaintenanceWindowResponse_scheduleTimezone :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

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

getMaintenanceWindowResponse_startDate :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

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

getMaintenanceWindowResponse_windowId :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The ID of the created maintenance window.

getMaintenanceWindowResponse_httpStatus :: Lens' GetMaintenanceWindowResponse Int Source #

The response's http status code.

GetMaintenanceWindowExecution

getMaintenanceWindowExecution_windowExecutionId :: Lens' GetMaintenanceWindowExecution Text Source #

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

getMaintenanceWindowExecutionResponse_endTime :: Lens' GetMaintenanceWindowExecutionResponse (Maybe UTCTime) Source #

The time the maintenance window finished running.

getMaintenanceWindowExecutionResponse_startTime :: Lens' GetMaintenanceWindowExecutionResponse (Maybe UTCTime) Source #

The time the maintenance window started running.

getMaintenanceWindowExecutionResponse_status :: Lens' GetMaintenanceWindowExecutionResponse (Maybe MaintenanceWindowExecutionStatus) Source #

The status of the maintenance window execution.

getMaintenanceWindowExecutionResponse_statusDetails :: Lens' GetMaintenanceWindowExecutionResponse (Maybe Text) Source #

The details explaining the status. Not available for all status values.

getMaintenanceWindowExecutionResponse_taskIds :: Lens' GetMaintenanceWindowExecutionResponse (Maybe [Text]) Source #

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

getMaintenanceWindowExecutionResponse_windowExecutionId :: Lens' GetMaintenanceWindowExecutionResponse (Maybe Text) Source #

The ID of the maintenance window execution.

getMaintenanceWindowExecutionResponse_httpStatus :: Lens' GetMaintenanceWindowExecutionResponse Int Source #

The response's http status code.

GetMaintenanceWindowExecutionTask

getMaintenanceWindowExecutionTask_windowExecutionId :: Lens' GetMaintenanceWindowExecutionTask Text Source #

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

getMaintenanceWindowExecutionTask_taskId :: Lens' GetMaintenanceWindowExecutionTask Text Source #

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

getMaintenanceWindowExecutionTaskResponse_alarmConfiguration :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe AlarmConfiguration) Source #

The details for the CloudWatch alarm you applied to your maintenance window task.

getMaintenanceWindowExecutionTaskResponse_endTime :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe UTCTime) Source #

The time the task execution completed.

getMaintenanceWindowExecutionTaskResponse_maxConcurrency :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

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

getMaintenanceWindowExecutionTaskResponse_maxErrors :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

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

getMaintenanceWindowExecutionTaskResponse_priority :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Natural) Source #

The priority of the task.

getMaintenanceWindowExecutionTaskResponse_serviceRole :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The role that was assumed when running the task.

getMaintenanceWindowExecutionTaskResponse_startTime :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe UTCTime) Source #

The time the task execution started.

getMaintenanceWindowExecutionTaskResponse_status :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe MaintenanceWindowExecutionStatus) Source #

The status of the task.

getMaintenanceWindowExecutionTaskResponse_statusDetails :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The details explaining the status. Not available for all status values.

getMaintenanceWindowExecutionTaskResponse_taskArn :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task that ran.

getMaintenanceWindowExecutionTaskResponse_taskExecutionId :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

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

getMaintenanceWindowExecutionTaskResponse_taskParameters :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe [HashMap Text MaintenanceWindowTaskParameterValueExpression]) Source #

The parameters passed to the task when it was run.

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

The map has the following format:

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

getMaintenanceWindowExecutionTaskResponse_triggeredAlarms :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarms that were invoked by the maintenance window task.

getMaintenanceWindowExecutionTaskResponse_type :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe MaintenanceWindowTaskType) Source #

The type of task that was run.

getMaintenanceWindowExecutionTaskResponse_windowExecutionId :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

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

getMaintenanceWindowExecutionTaskResponse_httpStatus :: Lens' GetMaintenanceWindowExecutionTaskResponse Int Source #

The response's http status code.

GetMaintenanceWindowExecutionTaskInvocation

getMaintenanceWindowExecutionTaskInvocation_windowExecutionId :: Lens' GetMaintenanceWindowExecutionTaskInvocation Text Source #

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

getMaintenanceWindowExecutionTaskInvocation_taskId :: Lens' GetMaintenanceWindowExecutionTaskInvocation Text Source #

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

getMaintenanceWindowExecutionTaskInvocation_invocationId :: Lens' GetMaintenanceWindowExecutionTaskInvocation Text Source #

The invocation ID to retrieve.

getMaintenanceWindowExecutionTaskInvocationResponse_endTime :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe UTCTime) Source #

The time that the task finished running on the target.

getMaintenanceWindowExecutionTaskInvocationResponse_executionId :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe Text) Source #

The execution ID.

getMaintenanceWindowExecutionTaskInvocationResponse_invocationId :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe Text) Source #

The invocation ID.

getMaintenanceWindowExecutionTaskInvocationResponse_ownerInformation :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe Text) Source #

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

getMaintenanceWindowExecutionTaskInvocationResponse_parameters :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe Text) Source #

The parameters used at the time that the task ran.

getMaintenanceWindowExecutionTaskInvocationResponse_startTime :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe UTCTime) Source #

The time that the task started running on the target.

getMaintenanceWindowExecutionTaskInvocationResponse_status :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe MaintenanceWindowExecutionStatus) Source #

The task status for an invocation.

getMaintenanceWindowExecutionTaskInvocationResponse_statusDetails :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe Text) Source #

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

getMaintenanceWindowExecutionTaskInvocationResponse_taskExecutionId :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe Text) Source #

The task execution ID.

getMaintenanceWindowExecutionTaskInvocationResponse_taskType :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe MaintenanceWindowTaskType) Source #

Retrieves the task type for a maintenance window.

getMaintenanceWindowExecutionTaskInvocationResponse_windowExecutionId :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe Text) Source #

The maintenance window execution ID.

getMaintenanceWindowExecutionTaskInvocationResponse_windowTargetId :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse (Maybe Text) Source #

The maintenance window target ID.

getMaintenanceWindowExecutionTaskInvocationResponse_httpStatus :: Lens' GetMaintenanceWindowExecutionTaskInvocationResponse Int Source #

The response's http status code.

GetMaintenanceWindowTask

getMaintenanceWindowTask_windowId :: Lens' GetMaintenanceWindowTask Text Source #

The maintenance window ID that includes the task to retrieve.

getMaintenanceWindowTask_windowTaskId :: Lens' GetMaintenanceWindowTask Text Source #

The maintenance window task ID to retrieve.

getMaintenanceWindowTaskResponse_alarmConfiguration :: Lens' GetMaintenanceWindowTaskResponse (Maybe AlarmConfiguration) Source #

The details for the CloudWatch alarm you applied to your maintenance window task.

getMaintenanceWindowTaskResponse_cutoffBehavior :: Lens' GetMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskCutoffBehavior) Source #

The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

getMaintenanceWindowTaskResponse_description :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #

The retrieved task description.

getMaintenanceWindowTaskResponse_loggingInfo :: Lens' GetMaintenanceWindowTaskResponse (Maybe LoggingInfo) Source #

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

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

getMaintenanceWindowTaskResponse_maxConcurrency :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #

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

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

getMaintenanceWindowTaskResponse_maxErrors :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #

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

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

getMaintenanceWindowTaskResponse_name :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #

The retrieved task name.

getMaintenanceWindowTaskResponse_priority :: Lens' GetMaintenanceWindowTaskResponse (Maybe Natural) Source #

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

getMaintenanceWindowTaskResponse_serviceRoleArn :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #

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

getMaintenanceWindowTaskResponse_targets :: Lens' GetMaintenanceWindowTaskResponse (Maybe [Target]) Source #

The targets where the task should run.

getMaintenanceWindowTaskResponse_taskArn :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #

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

getMaintenanceWindowTaskResponse_taskInvocationParameters :: Lens' GetMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskInvocationParameters) Source #

The parameters to pass to the task when it runs.

getMaintenanceWindowTaskResponse_taskParameters :: Lens' GetMaintenanceWindowTaskResponse (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #

The parameters to pass to the task when it runs.

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

getMaintenanceWindowTaskResponse_taskType :: Lens' GetMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskType) Source #

The type of task to run.

getMaintenanceWindowTaskResponse_windowId :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #

The retrieved maintenance window ID.

getMaintenanceWindowTaskResponse_windowTaskId :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #

The retrieved maintenance window task ID.

getMaintenanceWindowTaskResponse_httpStatus :: Lens' GetMaintenanceWindowTaskResponse Int Source #

The response's http status code.

GetOpsItem

getOpsItem_opsItemArn :: Lens' GetOpsItem (Maybe Text) Source #

The OpsItem Amazon Resource Name (ARN).

getOpsItem_opsItemId :: Lens' GetOpsItem Text Source #

The ID of the OpsItem that you want to get.

getOpsItemResponse_opsItem :: Lens' GetOpsItemResponse (Maybe OpsItem) Source #

The OpsItem.

getOpsItemResponse_httpStatus :: Lens' GetOpsItemResponse Int Source #

The response's http status code.

GetOpsMetadata

getOpsMetadata_maxResults :: Lens' GetOpsMetadata (Maybe Natural) Source #

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.

getOpsMetadata_nextToken :: Lens' GetOpsMetadata (Maybe Text) Source #

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

getOpsMetadata_opsMetadataArn :: Lens' GetOpsMetadata Text Source #

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

getOpsMetadataResponse_metadata :: Lens' GetOpsMetadataResponse (Maybe (HashMap Text MetadataValue)) Source #

OpsMetadata for an Application Manager application.

getOpsMetadataResponse_nextToken :: Lens' GetOpsMetadataResponse (Maybe Text) Source #

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

getOpsMetadataResponse_resourceId :: Lens' GetOpsMetadataResponse (Maybe Text) Source #

The resource ID of the Application Manager application.

getOpsMetadataResponse_httpStatus :: Lens' GetOpsMetadataResponse Int Source #

The response's http status code.

GetOpsSummary

getOpsSummary_aggregators :: Lens' GetOpsSummary (Maybe (NonEmpty OpsAggregator)) Source #

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

getOpsSummary_filters :: Lens' GetOpsSummary (Maybe (NonEmpty OpsFilter)) Source #

Optional filters used to scope down the returned OpsData.

getOpsSummary_maxResults :: Lens' GetOpsSummary (Maybe Natural) Source #

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.

getOpsSummary_nextToken :: Lens' GetOpsSummary (Maybe Text) Source #

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

getOpsSummary_resultAttributes :: Lens' GetOpsSummary (Maybe (NonEmpty OpsResultAttribute)) Source #

The OpsData data type to return.

getOpsSummary_syncName :: Lens' GetOpsSummary (Maybe Text) Source #

Specify the name of a resource data sync to get.

getOpsSummaryResponse_entities :: Lens' GetOpsSummaryResponse (Maybe [OpsEntity]) Source #

The list of aggregated details and filtered OpsData.

getOpsSummaryResponse_nextToken :: Lens' GetOpsSummaryResponse (Maybe Text) Source #

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

getOpsSummaryResponse_httpStatus :: Lens' GetOpsSummaryResponse Int Source #

The response's http status code.

GetParameter

getParameter_withDecryption :: Lens' GetParameter (Maybe Bool) Source #

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

getParameter_name :: Lens' GetParameter Text Source #

The name of the parameter you want to query.

To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

getParameterResponse_httpStatus :: Lens' GetParameterResponse Int Source #

The response's http status code.

getParameterResponse_parameter :: Lens' GetParameterResponse Parameter Source #

Information about a parameter.

GetParameterHistory

getParameterHistory_maxResults :: Lens' GetParameterHistory (Maybe Natural) Source #

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.

getParameterHistory_nextToken :: Lens' GetParameterHistory (Maybe Text) Source #

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

getParameterHistory_withDecryption :: Lens' GetParameterHistory (Maybe Bool) Source #

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

getParameterHistory_name :: Lens' GetParameterHistory Text Source #

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

getParameterHistoryResponse_nextToken :: Lens' GetParameterHistoryResponse (Maybe Text) Source #

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

getParameterHistoryResponse_parameters :: Lens' GetParameterHistoryResponse (Maybe [ParameterHistory]) Source #

A list of parameters returned by the request.

getParameterHistoryResponse_httpStatus :: Lens' GetParameterHistoryResponse Int Source #

The response's http status code.

GetParameters

getParameters_withDecryption :: Lens' GetParameters (Maybe Bool) Source #

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

getParameters_names :: Lens' GetParameters (NonEmpty Text) Source #

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

To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

getParametersResponse_httpStatus :: Lens' GetParametersResponse Int Source #

The response's http status code.

getParametersResponse_invalidParameters :: Lens' GetParametersResponse [Text] Source #

A list of parameters that aren't formatted correctly or don't run during an execution.

getParametersResponse_parameters :: Lens' GetParametersResponse [Parameter] Source #

A list of details for a parameter.

GetParametersByPath

getParametersByPath_maxResults :: Lens' GetParametersByPath (Maybe Natural) Source #

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.

getParametersByPath_nextToken :: Lens' GetParametersByPath (Maybe Text) Source #

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

getParametersByPath_parameterFilters :: Lens' GetParametersByPath (Maybe [ParameterStringFilter]) Source #

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

getParametersByPath_recursive :: Lens' GetParametersByPath (Maybe Bool) Source #

Retrieve all parameters within a hierarchy.

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

getParametersByPath_withDecryption :: Lens' GetParametersByPath (Maybe Bool) Source #

Retrieve all parameters in a hierarchy with their value decrypted.

getParametersByPath_path :: Lens' GetParametersByPath Text Source #

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

getParametersByPathResponse_nextToken :: Lens' GetParametersByPathResponse (Maybe Text) Source #

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

getParametersByPathResponse_parameters :: Lens' GetParametersByPathResponse (Maybe [Parameter]) Source #

A list of parameters found in the specified hierarchy.

getParametersByPathResponse_httpStatus :: Lens' GetParametersByPathResponse Int Source #

The response's http status code.

GetPatchBaseline

getPatchBaseline_baselineId :: Lens' GetPatchBaseline Text Source #

The ID of the patch baseline to retrieve.

To retrieve information about an Amazon Web Services managed patch baseline, specify the full Amazon Resource Name (ARN) of the baseline. For example, for the baseline AWS-AmazonLinuxDefaultPatchBaseline, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7 instead of pb-0e392de35e7c563b7.

getPatchBaselineResponse_approvalRules :: Lens' GetPatchBaselineResponse (Maybe PatchRuleGroup) Source #

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

getPatchBaselineResponse_approvedPatches :: Lens' GetPatchBaselineResponse (Maybe [Text]) Source #

A list of explicitly approved patches for the baseline.

getPatchBaselineResponse_approvedPatchesComplianceLevel :: Lens' GetPatchBaselineResponse (Maybe PatchComplianceLevel) Source #

Returns the specified compliance severity level for approved patches in the patch baseline.

getPatchBaselineResponse_approvedPatchesEnableNonSecurity :: Lens' GetPatchBaselineResponse (Maybe Bool) Source #

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

getPatchBaselineResponse_baselineId :: Lens' GetPatchBaselineResponse (Maybe Text) Source #

The ID of the retrieved patch baseline.

getPatchBaselineResponse_createdDate :: Lens' GetPatchBaselineResponse (Maybe UTCTime) Source #

The date the patch baseline was created.

getPatchBaselineResponse_description :: Lens' GetPatchBaselineResponse (Maybe Text) Source #

A description of the patch baseline.

getPatchBaselineResponse_globalFilters :: Lens' GetPatchBaselineResponse (Maybe PatchFilterGroup) Source #

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

getPatchBaselineResponse_modifiedDate :: Lens' GetPatchBaselineResponse (Maybe UTCTime) Source #

The date the patch baseline was last modified.

getPatchBaselineResponse_name :: Lens' GetPatchBaselineResponse (Maybe Text) Source #

The name of the patch baseline.

getPatchBaselineResponse_operatingSystem :: Lens' GetPatchBaselineResponse (Maybe OperatingSystem) Source #

Returns the operating system specified for the patch baseline.

getPatchBaselineResponse_patchGroups :: Lens' GetPatchBaselineResponse (Maybe [Text]) Source #

Patch groups included in the patch baseline.

getPatchBaselineResponse_rejectedPatches :: Lens' GetPatchBaselineResponse (Maybe [Text]) Source #

A list of explicitly rejected patches for the baseline.

getPatchBaselineResponse_rejectedPatchesAction :: Lens' GetPatchBaselineResponse (Maybe PatchAction) Source #

The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

getPatchBaselineResponse_sources :: Lens' GetPatchBaselineResponse (Maybe [PatchSource]) Source #

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

getPatchBaselineResponse_httpStatus :: Lens' GetPatchBaselineResponse Int Source #

The response's http status code.

GetPatchBaselineForPatchGroup

getPatchBaselineForPatchGroup_operatingSystem :: Lens' GetPatchBaselineForPatchGroup (Maybe OperatingSystem) Source #

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

getPatchBaselineForPatchGroup_patchGroup :: Lens' GetPatchBaselineForPatchGroup Text Source #

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

getPatchBaselineForPatchGroupResponse_baselineId :: Lens' GetPatchBaselineForPatchGroupResponse (Maybe Text) Source #

The ID of the patch baseline that should be used for the patch group.

getPatchBaselineForPatchGroupResponse_operatingSystem :: Lens' GetPatchBaselineForPatchGroupResponse (Maybe OperatingSystem) Source #

The operating system rule specified for patch groups using the patch baseline.

getPatchBaselineForPatchGroupResponse_patchGroup :: Lens' GetPatchBaselineForPatchGroupResponse (Maybe Text) Source #

The name of the patch group.

getPatchBaselineForPatchGroupResponse_httpStatus :: Lens' GetPatchBaselineForPatchGroupResponse Int Source #

The response's http status code.

GetResourcePolicies

getResourcePolicies_maxResults :: Lens' GetResourcePolicies (Maybe Natural) Source #

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.

getResourcePolicies_nextToken :: Lens' GetResourcePolicies (Maybe Text) Source #

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

getResourcePolicies_resourceArn :: Lens' GetResourcePolicies Text Source #

Amazon Resource Name (ARN) of the resource to which the policies are attached.

getResourcePoliciesResponse_nextToken :: Lens' GetResourcePoliciesResponse (Maybe Text) Source #

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

getResourcePoliciesResponse_policies :: Lens' GetResourcePoliciesResponse (Maybe [GetResourcePoliciesResponseEntry]) Source #

An array of the Policy object.

getResourcePoliciesResponse_httpStatus :: Lens' GetResourcePoliciesResponse Int Source #

The response's http status code.

GetServiceSetting

getServiceSetting_settingId :: Lens' GetServiceSetting Text Source #

The ID of the service setting to get. The setting ID can be one of the following.

/ssm/automation/customer-script-log-destination

/ssm/automation/customer-script-log-group-name

/ssm/documents/console/public-sharing-permission

```
/ssm/managed-instance/activation-tier
```
```
/ssm/opsinsights/opscenter
```

/ssm/parameter-store/default-parameter-tier

/ssm/parameter-store/high-throughput-enabled

getServiceSettingResponse_serviceSetting :: Lens' GetServiceSettingResponse (Maybe ServiceSetting) Source #

The query result of the current service setting.

getServiceSettingResponse_httpStatus :: Lens' GetServiceSettingResponse Int Source #

The response's http status code.

LabelParameterVersion

labelParameterVersion_parameterVersion :: Lens' LabelParameterVersion (Maybe Integer) Source #

The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.

labelParameterVersion_name :: Lens' LabelParameterVersion Text Source #

The parameter name on which you want to attach one or more labels.

labelParameterVersion_labels :: Lens' LabelParameterVersion (NonEmpty Text) Source #

One or more labels to attach to the specified parameter version.

labelParameterVersionResponse_invalidLabels :: Lens' LabelParameterVersionResponse (Maybe (NonEmpty Text)) Source #

The label doesn't meet the requirements. For information about parameter label requirements, see Labeling parameters in the Amazon Web Services Systems Manager User Guide.

labelParameterVersionResponse_parameterVersion :: Lens' LabelParameterVersionResponse (Maybe Integer) Source #

The version of the parameter that has been labeled.

labelParameterVersionResponse_httpStatus :: Lens' LabelParameterVersionResponse Int Source #

The response's http status code.

ListAssociationVersions

listAssociationVersions_maxResults :: Lens' ListAssociationVersions (Maybe Natural) Source #

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.

listAssociationVersions_nextToken :: Lens' ListAssociationVersions (Maybe Text) Source #

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

listAssociationVersions_associationId :: Lens' ListAssociationVersions Text Source #

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

listAssociationVersionsResponse_associationVersions :: Lens' ListAssociationVersionsResponse (Maybe (NonEmpty AssociationVersionInfo)) Source #

Information about all versions of the association for the specified association ID.

listAssociationVersionsResponse_nextToken :: Lens' ListAssociationVersionsResponse (Maybe Text) Source #

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

listAssociationVersionsResponse_httpStatus :: Lens' ListAssociationVersionsResponse Int Source #

The response's http status code.

ListAssociations

listAssociations_associationFilterList :: Lens' ListAssociations (Maybe (NonEmpty AssociationFilter)) Source #

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

Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the managed node that are part of the Target Attributes ResourceGroup or Tags aren't returned.

listAssociations_maxResults :: Lens' ListAssociations (Maybe Natural) Source #

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.

listAssociations_nextToken :: Lens' ListAssociations (Maybe Text) Source #

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

listAssociationsResponse_associations :: Lens' ListAssociationsResponse (Maybe [Association]) Source #

The associations.

listAssociationsResponse_nextToken :: Lens' ListAssociationsResponse (Maybe Text) Source #

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

listAssociationsResponse_httpStatus :: Lens' ListAssociationsResponse Int Source #

The response's http status code.

ListCommandInvocations

listCommandInvocations_commandId :: Lens' ListCommandInvocations (Maybe Text) Source #

(Optional) The invocations for a specific command ID.

listCommandInvocations_details :: Lens' ListCommandInvocations (Maybe Bool) Source #

(Optional) If set this returns the response of the command executions and any command output. The default value is false.

listCommandInvocations_filters :: Lens' ListCommandInvocations (Maybe (NonEmpty CommandFilter)) Source #

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

listCommandInvocations_instanceId :: Lens' ListCommandInvocations (Maybe Text) Source #

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

listCommandInvocations_maxResults :: Lens' ListCommandInvocations (Maybe Natural) Source #

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

listCommandInvocations_nextToken :: Lens' ListCommandInvocations (Maybe Text) Source #

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

listCommandInvocationsResponse_commandInvocations :: Lens' ListCommandInvocationsResponse (Maybe [CommandInvocation]) Source #

(Optional) A list of all invocations.

listCommandInvocationsResponse_nextToken :: Lens' ListCommandInvocationsResponse (Maybe Text) Source #

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

listCommandInvocationsResponse_httpStatus :: Lens' ListCommandInvocationsResponse Int Source #

The response's http status code.

ListCommands

listCommands_commandId :: Lens' ListCommands (Maybe Text) Source #

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

listCommands_filters :: Lens' ListCommands (Maybe (NonEmpty CommandFilter)) Source #

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

listCommands_instanceId :: Lens' ListCommands (Maybe Text) Source #

(Optional) Lists commands issued against this managed node ID.

You can't specify a managed node ID in the same command that you specify Status = Pending. This is because the command hasn't reached the managed node yet.

listCommands_maxResults :: Lens' ListCommands (Maybe Natural) Source #

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

listCommands_nextToken :: Lens' ListCommands (Maybe Text) Source #

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

listCommandsResponse_commands :: Lens' ListCommandsResponse (Maybe [Command]) Source #

(Optional) The list of commands requested by the user.

listCommandsResponse_nextToken :: Lens' ListCommandsResponse (Maybe Text) Source #

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

listCommandsResponse_httpStatus :: Lens' ListCommandsResponse Int Source #

The response's http status code.

ListComplianceItems

listComplianceItems_filters :: Lens' ListComplianceItems (Maybe [ComplianceStringFilter]) Source #

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

listComplianceItems_maxResults :: Lens' ListComplianceItems (Maybe Natural) Source #

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.

listComplianceItems_nextToken :: Lens' ListComplianceItems (Maybe Text) Source #

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

listComplianceItems_resourceIds :: Lens' ListComplianceItems (Maybe (NonEmpty Text)) Source #

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

listComplianceItems_resourceTypes :: Lens' ListComplianceItems (Maybe (NonEmpty Text)) Source #

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

listComplianceItemsResponse_complianceItems :: Lens' ListComplianceItemsResponse (Maybe [ComplianceItem]) Source #

A list of compliance information for the specified resource ID.

listComplianceItemsResponse_nextToken :: Lens' ListComplianceItemsResponse (Maybe Text) Source #

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

listComplianceItemsResponse_httpStatus :: Lens' ListComplianceItemsResponse Int Source #

The response's http status code.

ListComplianceSummaries

listComplianceSummaries_filters :: Lens' ListComplianceSummaries (Maybe [ComplianceStringFilter]) Source #

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

listComplianceSummaries_maxResults :: Lens' ListComplianceSummaries (Maybe Natural) Source #

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.

listComplianceSummaries_nextToken :: Lens' ListComplianceSummaries (Maybe Text) Source #

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

listComplianceSummariesResponse_complianceSummaryItems :: Lens' ListComplianceSummariesResponse (Maybe [ComplianceSummaryItem]) Source #

A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

listComplianceSummariesResponse_nextToken :: Lens' ListComplianceSummariesResponse (Maybe Text) Source #

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

listComplianceSummariesResponse_httpStatus :: Lens' ListComplianceSummariesResponse Int Source #

The response's http status code.

ListDocumentMetadataHistory

listDocumentMetadataHistory_documentVersion :: Lens' ListDocumentMetadataHistory (Maybe Text) Source #

The version of the change template.

listDocumentMetadataHistory_maxResults :: Lens' ListDocumentMetadataHistory (Maybe Natural) Source #

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.

listDocumentMetadataHistory_nextToken :: Lens' ListDocumentMetadataHistory (Maybe Text) Source #

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

listDocumentMetadataHistory_name :: Lens' ListDocumentMetadataHistory Text Source #

The name of the change template.

listDocumentMetadataHistory_metadata :: Lens' ListDocumentMetadataHistory DocumentMetadataEnum Source #

The type of data for which details are being requested. Currently, the only supported value is DocumentReviews.

listDocumentMetadataHistoryResponse_author :: Lens' ListDocumentMetadataHistoryResponse (Maybe Text) Source #

The user ID of the person in the organization who requested the review of the change template.

listDocumentMetadataHistoryResponse_documentVersion :: Lens' ListDocumentMetadataHistoryResponse (Maybe Text) Source #

The version of the change template.

listDocumentMetadataHistoryResponse_metadata :: Lens' ListDocumentMetadataHistoryResponse (Maybe DocumentMetadataResponseInfo) Source #

Information about the response to the change template approval request.

listDocumentMetadataHistoryResponse_name :: Lens' ListDocumentMetadataHistoryResponse (Maybe Text) Source #

The name of the change template.

listDocumentMetadataHistoryResponse_nextToken :: Lens' ListDocumentMetadataHistoryResponse (Maybe Text) Source #

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.

listDocumentMetadataHistoryResponse_httpStatus :: Lens' ListDocumentMetadataHistoryResponse Int Source #

The response's http status code.

ListDocumentVersions

listDocumentVersions_maxResults :: Lens' ListDocumentVersions (Maybe Natural) Source #

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.

listDocumentVersions_nextToken :: Lens' ListDocumentVersions (Maybe Text) Source #

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

listDocumentVersions_name :: Lens' ListDocumentVersions Text Source #

The name of the document. You can specify an Amazon Resource Name (ARN).

listDocumentVersionsResponse_documentVersions :: Lens' ListDocumentVersionsResponse (Maybe (NonEmpty DocumentVersionInfo)) Source #

The document versions.

listDocumentVersionsResponse_nextToken :: Lens' ListDocumentVersionsResponse (Maybe Text) Source #

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

listDocumentVersionsResponse_httpStatus :: Lens' ListDocumentVersionsResponse Int Source #

The response's http status code.

ListDocuments

listDocuments_documentFilterList :: Lens' ListDocuments (Maybe (NonEmpty DocumentFilter)) Source #

This data type is deprecated. Instead, use Filters.

listDocuments_filters :: Lens' ListDocuments (Maybe [DocumentKeyValuesFilter]) Source #

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

listDocuments_maxResults :: Lens' ListDocuments (Maybe Natural) Source #

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.

listDocuments_nextToken :: Lens' ListDocuments (Maybe Text) Source #

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

listDocumentsResponse_documentIdentifiers :: Lens' ListDocumentsResponse (Maybe [DocumentIdentifier]) Source #

The names of the SSM documents.

listDocumentsResponse_nextToken :: Lens' ListDocumentsResponse (Maybe Text) Source #

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

listDocumentsResponse_httpStatus :: Lens' ListDocumentsResponse Int Source #

The response's http status code.

ListInventoryEntries

listInventoryEntries_filters :: Lens' ListInventoryEntries (Maybe (NonEmpty InventoryFilter)) Source #

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

listInventoryEntries_maxResults :: Lens' ListInventoryEntries (Maybe Natural) Source #

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.

listInventoryEntries_nextToken :: Lens' ListInventoryEntries (Maybe Text) Source #

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

listInventoryEntries_instanceId :: Lens' ListInventoryEntries Text Source #

The managed node ID for which you want inventory information.

listInventoryEntries_typeName :: Lens' ListInventoryEntries Text Source #

The type of inventory item for which you want information.

listInventoryEntriesResponse_captureTime :: Lens' ListInventoryEntriesResponse (Maybe Text) Source #

The time that inventory information was collected for the managed node(s).

listInventoryEntriesResponse_entries :: Lens' ListInventoryEntriesResponse (Maybe [HashMap Text Text]) Source #

A list of inventory items on the managed node(s).

listInventoryEntriesResponse_instanceId :: Lens' ListInventoryEntriesResponse (Maybe Text) Source #

The managed node ID targeted by the request to query inventory information.

listInventoryEntriesResponse_nextToken :: Lens' ListInventoryEntriesResponse (Maybe Text) Source #

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

listInventoryEntriesResponse_schemaVersion :: Lens' ListInventoryEntriesResponse (Maybe Text) Source #

The inventory schema version used by the managed node(s).

listInventoryEntriesResponse_typeName :: Lens' ListInventoryEntriesResponse (Maybe Text) Source #

The type of inventory item returned by the request.

listInventoryEntriesResponse_httpStatus :: Lens' ListInventoryEntriesResponse Int Source #

The response's http status code.

ListOpsItemEvents

listOpsItemEvents_filters :: Lens' ListOpsItemEvents (Maybe [OpsItemEventFilter]) Source #

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

listOpsItemEvents_maxResults :: Lens' ListOpsItemEvents (Maybe Natural) Source #

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.

listOpsItemEvents_nextToken :: Lens' ListOpsItemEvents (Maybe Text) Source #

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

listOpsItemEventsResponse_nextToken :: Lens' ListOpsItemEventsResponse (Maybe Text) Source #

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

listOpsItemEventsResponse_summaries :: Lens' ListOpsItemEventsResponse (Maybe [OpsItemEventSummary]) Source #

A list of event information for the specified OpsItems.

listOpsItemEventsResponse_httpStatus :: Lens' ListOpsItemEventsResponse Int Source #

The response's http status code.

ListOpsItemRelatedItems

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

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.

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

The ID of the OpsItem for which you want to list all related-item resources.

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

A list of related-item resources for the specified OpsItem.

The response's http status code.

ListOpsMetadata

listOpsMetadata_filters :: Lens' ListOpsMetadata (Maybe [OpsMetadataFilter]) Source #

One or more filters to limit the number of OpsMetadata objects returned by the call.

listOpsMetadata_maxResults :: Lens' ListOpsMetadata (Maybe Natural) Source #

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.

listOpsMetadata_nextToken :: Lens' ListOpsMetadata (Maybe Text) Source #

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

listOpsMetadataResponse_nextToken :: Lens' ListOpsMetadataResponse (Maybe Text) Source #

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

listOpsMetadataResponse_opsMetadataList :: Lens' ListOpsMetadataResponse (Maybe (NonEmpty OpsMetadata)) Source #

Returns a list of OpsMetadata objects.

listOpsMetadataResponse_httpStatus :: Lens' ListOpsMetadataResponse Int Source #

The response's http status code.

ListResourceComplianceSummaries

listResourceComplianceSummaries_filters :: Lens' ListResourceComplianceSummaries (Maybe [ComplianceStringFilter]) Source #

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

listResourceComplianceSummaries_maxResults :: Lens' ListResourceComplianceSummaries (Maybe Natural) Source #

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.

listResourceComplianceSummaries_nextToken :: Lens' ListResourceComplianceSummaries (Maybe Text) Source #

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

listResourceComplianceSummariesResponse_nextToken :: Lens' ListResourceComplianceSummariesResponse (Maybe Text) Source #

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

listResourceComplianceSummariesResponse_resourceComplianceSummaryItems :: Lens' ListResourceComplianceSummariesResponse (Maybe [ResourceComplianceSummaryItem]) Source #

A summary count for specified or targeted managed nodes. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.

listResourceComplianceSummariesResponse_httpStatus :: Lens' ListResourceComplianceSummariesResponse Int Source #

The response's http status code.

ListResourceDataSync

listResourceDataSync_maxResults :: Lens' ListResourceDataSync (Maybe Natural) Source #

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.

listResourceDataSync_nextToken :: Lens' ListResourceDataSync (Maybe Text) Source #

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

listResourceDataSync_syncType :: Lens' ListResourceDataSync (Maybe Text) Source #

View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from Organizations or from multiple Amazon Web Services Regions.

listResourceDataSyncResponse_nextToken :: Lens' ListResourceDataSyncResponse (Maybe Text) Source #

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

listResourceDataSyncResponse_resourceDataSyncItems :: Lens' ListResourceDataSyncResponse (Maybe [ResourceDataSyncItem]) Source #

A list of your current resource data sync configurations and their statuses.

listResourceDataSyncResponse_httpStatus :: Lens' ListResourceDataSyncResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceType :: Lens' ListTagsForResource ResourceTypeForTagging Source #

Returns a list of tags for a specific resource type.

listTagsForResource_resourceId :: Lens' ListTagsForResource Text Source #

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

listTagsForResourceResponse_tagList :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

A list of tags.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ModifyDocumentPermission

modifyDocumentPermission_accountIdsToAdd :: Lens' ModifyDocumentPermission (Maybe [Text]) Source #

The Amazon Web Services user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

modifyDocumentPermission_accountIdsToRemove :: Lens' ModifyDocumentPermission (Maybe [Text]) Source #

The Amazon Web Services user accounts that should no longer have access to the document. The Amazon Web Services 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.

modifyDocumentPermission_sharedDocumentVersion :: Lens' ModifyDocumentPermission (Maybe Text) Source #

(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

modifyDocumentPermission_name :: Lens' ModifyDocumentPermission Text Source #

The name of the document that you want to share.

modifyDocumentPermission_permissionType :: Lens' ModifyDocumentPermission DocumentPermissionType Source #

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

modifyDocumentPermissionResponse_httpStatus :: Lens' ModifyDocumentPermissionResponse Int Source #

The response's http status code.

PutComplianceItems

putComplianceItems_itemContentHash :: Lens' PutComplianceItems (Maybe Text) Source #

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.

putComplianceItems_uploadType :: Lens' PutComplianceItems (Maybe ComplianceUploadType) Source #

The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

This attribute is only valid for association compliance.

putComplianceItems_resourceId :: Lens' PutComplianceItems Text Source #

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

putComplianceItems_resourceType :: Lens' PutComplianceItems Text Source #

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

putComplianceItems_complianceType :: Lens' PutComplianceItems Text Source #

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

putComplianceItems_executionSummary :: Lens' PutComplianceItems ComplianceExecutionSummary Source #

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

putComplianceItems_items :: Lens' PutComplianceItems [ComplianceItemEntry] Source #

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

putComplianceItemsResponse_httpStatus :: Lens' PutComplianceItemsResponse Int Source #

The response's http status code.

PutInventory

putInventory_instanceId :: Lens' PutInventory Text Source #

An managed node ID where you want to add or update inventory items.

putInventory_items :: Lens' PutInventory (NonEmpty InventoryItem) Source #

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

putInventoryResponse_message :: Lens' PutInventoryResponse (Maybe Text) Source #

Information about the request.

putInventoryResponse_httpStatus :: Lens' PutInventoryResponse Int Source #

The response's http status code.

PutParameter

putParameter_allowedPattern :: Lens' PutParameter (Maybe Text) Source #

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+$

putParameter_dataType :: Lens' PutParameter (Maybe Text) Source #

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.

The following data type values are supported.

```
text
```
```
aws:ec2:image
```
```
aws:ssm:integration
```

When you create a String parameter and specify aws:ec2:image, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your Amazon Web Services account. For more information, see Native parameter support for Amazon Machine Image (AMI) IDs in the Amazon Web Services Systems Manager User Guide.

putParameter_description :: Lens' PutParameter (Maybe Text) Source #

Information about the parameter that you want to add to the system. Optional but recommended.

Don't enter personally identifiable information in this field.

putParameter_keyId :: Lens' PutParameter (Maybe Text) Source #

The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Either the default KMS key automatically assigned to your Amazon Web Services account or a custom key. Required for parameters that use the SecureString data type.

If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account.

To use your default KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
To use a custom KMS key, choose the SecureString data type with the Key ID parameter.

putParameter_overwrite :: Lens' PutParameter (Maybe Bool) Source #

Overwrite an existing parameter. The default value is false.

putParameter_policies :: Lens' PutParameter (Maybe Text) Source #

One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a capability of Amazon Web Services Systems Manager supports the following policy types:

Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.

All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.

putParameter_tags :: Lens' PutParameter (Maybe [Tag]) Source #

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:

```
Key=Resource,Value=S3bucket
```
```
Key=OS,Value=Windows
```
```
Key=ParameterType,Value=LicenseKey
```

To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation.

putParameter_tier :: Lens' PutParameter (Maybe ParameterTier) Source #

The parameter tier to assign to a parameter.

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

Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the Amazon Web Services Systems Manager User Guide.

You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.

If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.

Using the Default Tier Configuration

In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.

The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:

Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.
Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.
If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.
This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.

Options that require an advanced parameter include the following:

The content size of the parameter is more than 4 KB.
The parameter uses a parameter policy.
More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.

For more information about configuring the default tier option, see Specifying a default parameter tier in the Amazon Web Services Systems Manager User Guide.

putParameter_type :: Lens' PutParameter (Maybe ParameterType) Source #

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

SecureString isn't currently supported for CloudFormation templates.

Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.

Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.

putParameter_name :: Lens' PutParameter Text Source #

The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13

Naming Constraints:

Parameter names are case sensitive.
A parameter name must be unique within an Amazon Web Services Region
A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-
In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: /Dev/Production/East/Project-ABC/MyParameter
A parameter name can't include spaces.
Parameter hierarchies are limited to a maximum depth of fifteen levels.

For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

The maximum length constraint of 2048 characters listed below includes 1037 characters reserved for internal use by Systems Manager. The maximum length for a parameter name that you create is 1011 characters. This includes the characters in the ARN that precede the name you specify, such as arn:aws:ssm:us-east-2:111122223333:parameter/.

putParameter_value :: Lens' PutParameter Text Source #

The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.

Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

putParameterResponse_tier :: Lens' PutParameterResponse (Maybe ParameterTier) Source #

The tier assigned to the parameter.

putParameterResponse_httpStatus :: Lens' PutParameterResponse Int Source #

The response's http status code.

putParameterResponse_version :: Lens' PutParameterResponse Integer Source #

The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API operations or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.

PutResourcePolicy

putResourcePolicy_policyHash :: Lens' PutResourcePolicy (Maybe Text) Source #

ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.

putResourcePolicy_policyId :: Lens' PutResourcePolicy (Maybe Text) Source #

The policy ID.

putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text Source #

Amazon Resource Name (ARN) of the resource to which you want to attach a policy.

putResourcePolicy_policy :: Lens' PutResourcePolicy Text Source #

A policy you want to associate with a resource.

putResourcePolicyResponse_policyHash :: Lens' PutResourcePolicyResponse (Maybe Text) Source #

ID of the current policy version.

putResourcePolicyResponse_policyId :: Lens' PutResourcePolicyResponse (Maybe Text) Source #

The policy ID. To update a policy, you must specify PolicyId and PolicyHash.

putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int Source #

The response's http status code.

RegisterDefaultPatchBaseline

registerDefaultPatchBaseline_baselineId :: Lens' RegisterDefaultPatchBaseline Text Source #

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

registerDefaultPatchBaselineResponse_baselineId :: Lens' RegisterDefaultPatchBaselineResponse (Maybe Text) Source #

The ID of the default patch baseline.

registerDefaultPatchBaselineResponse_httpStatus :: Lens' RegisterDefaultPatchBaselineResponse Int Source #

The response's http status code.

RegisterPatchBaselineForPatchGroup

registerPatchBaselineForPatchGroup_baselineId :: Lens' RegisterPatchBaselineForPatchGroup Text Source #

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

registerPatchBaselineForPatchGroup_patchGroup :: Lens' RegisterPatchBaselineForPatchGroup Text Source #

The name of the patch group to be registered with the patch baseline.

registerPatchBaselineForPatchGroupResponse_baselineId :: Lens' RegisterPatchBaselineForPatchGroupResponse (Maybe Text) Source #

The ID of the patch baseline the patch group was registered with.

registerPatchBaselineForPatchGroupResponse_patchGroup :: Lens' RegisterPatchBaselineForPatchGroupResponse (Maybe Text) Source #

The name of the patch group registered with the patch baseline.

registerPatchBaselineForPatchGroupResponse_httpStatus :: Lens' RegisterPatchBaselineForPatchGroupResponse Int Source #

The response's http status code.

RegisterTargetWithMaintenanceWindow

registerTargetWithMaintenanceWindow_clientToken :: Lens' RegisterTargetWithMaintenanceWindow (Maybe Text) Source #

User-provided idempotency token.

registerTargetWithMaintenanceWindow_description :: Lens' RegisterTargetWithMaintenanceWindow (Maybe Text) Source #

An optional description for the target.

registerTargetWithMaintenanceWindow_name :: Lens' RegisterTargetWithMaintenanceWindow (Maybe Text) Source #

An optional name for the target.

registerTargetWithMaintenanceWindow_ownerInformation :: Lens' RegisterTargetWithMaintenanceWindow (Maybe Text) Source #

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

registerTargetWithMaintenanceWindow_windowId :: Lens' RegisterTargetWithMaintenanceWindow Text Source #

The ID of the maintenance window the target should be registered with.

registerTargetWithMaintenanceWindow_resourceType :: Lens' RegisterTargetWithMaintenanceWindow MaintenanceWindowResourceType Source #

The type of target being registered with the maintenance window.

registerTargetWithMaintenanceWindow_targets :: Lens' RegisterTargetWithMaintenanceWindow [Target] Source #

The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

Example 1: Specify managed node IDs

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

Example 2: Use tag key-pairs applied to managed nodes

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

Example 3: Use tag-keys applied to managed nodes

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

Example 4: Use resource group names

Key=resource-groups:Name,Values=<resource-group-name>

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.

registerTargetWithMaintenanceWindowResponse_windowTargetId :: Lens' RegisterTargetWithMaintenanceWindowResponse (Maybe Text) Source #

The ID of the target definition in this maintenance window.

registerTargetWithMaintenanceWindowResponse_httpStatus :: Lens' RegisterTargetWithMaintenanceWindowResponse Int Source #

The response's http status code.

RegisterTaskWithMaintenanceWindow

registerTaskWithMaintenanceWindow_alarmConfiguration :: Lens' RegisterTaskWithMaintenanceWindow (Maybe AlarmConfiguration) Source #

The CloudWatch alarm you want to apply to your maintenance window task.

registerTaskWithMaintenanceWindow_clientToken :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #

User-provided idempotency token.

registerTaskWithMaintenanceWindow_cutoffBehavior :: Lens' RegisterTaskWithMaintenanceWindow (Maybe MaintenanceWindowTaskCutoffBehavior) Source #

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.
CANCEL_TASK:
- For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
- For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
The status for tasks that are not completed is TIMED_OUT.

registerTaskWithMaintenanceWindow_description :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #

An optional description for the task.

registerTaskWithMaintenanceWindow_loggingInfo :: Lens' RegisterTaskWithMaintenanceWindow (Maybe LoggingInfo) Source #

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

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

registerTaskWithMaintenanceWindow_maxConcurrency :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

registerTaskWithMaintenanceWindow_maxErrors :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

registerTaskWithMaintenanceWindow_name :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #

An optional name for the task.

registerTaskWithMaintenanceWindow_priority :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Natural) Source #

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.

registerTaskWithMaintenanceWindow_serviceRoleArn :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the /Amazon Web Services Systems Manager User Guide/:

registerTaskWithMaintenanceWindow_targets :: Lens' RegisterTaskWithMaintenanceWindow (Maybe [Target]) Source #

The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

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

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

registerTaskWithMaintenanceWindow_taskInvocationParameters :: Lens' RegisterTaskWithMaintenanceWindow (Maybe MaintenanceWindowTaskInvocationParameters) Source #

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

registerTaskWithMaintenanceWindow_taskParameters :: Lens' RegisterTaskWithMaintenanceWindow (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #

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

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

registerTaskWithMaintenanceWindow_windowId :: Lens' RegisterTaskWithMaintenanceWindow Text Source #

The ID of the maintenance window the task should be added to.

registerTaskWithMaintenanceWindow_taskArn :: Lens' RegisterTaskWithMaintenanceWindow Text Source #

The ARN of the task to run.

registerTaskWithMaintenanceWindow_taskType :: Lens' RegisterTaskWithMaintenanceWindow MaintenanceWindowTaskType Source #

The type of task being registered.

registerTaskWithMaintenanceWindowResponse_windowTaskId :: Lens' RegisterTaskWithMaintenanceWindowResponse (Maybe Text) Source #

The ID of the task in the maintenance window.

registerTaskWithMaintenanceWindowResponse_httpStatus :: Lens' RegisterTaskWithMaintenanceWindowResponse Int Source #

The response's http status code.

RemoveTagsFromResource

removeTagsFromResource_resourceType :: Lens' RemoveTagsFromResource ResourceTypeForTagging Source #

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

The ManagedInstance type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.

removeTagsFromResource_resourceId :: Lens' RemoveTagsFromResource Text Source #

The ID of the resource from which you want to remove tags. For example:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

Automation: example-c160-4567-8519-012345abcde

PatchBaseline: pb-012345abcde

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

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

The ManagedInstance type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

removeTagsFromResource_tagKeys :: Lens' RemoveTagsFromResource [Text] Source #

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

removeTagsFromResourceResponse_httpStatus :: Lens' RemoveTagsFromResourceResponse Int Source #

The response's http status code.

ResetServiceSetting

resetServiceSetting_settingId :: Lens' ResetServiceSetting Text Source #

The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.

/ssm/automation/customer-script-log-destination

/ssm/automation/customer-script-log-group-name

/ssm/documents/console/public-sharing-permission

```
/ssm/managed-instance/activation-tier
```
```
/ssm/opsinsights/opscenter
```

/ssm/parameter-store/default-parameter-tier

/ssm/parameter-store/high-throughput-enabled

resetServiceSettingResponse_serviceSetting :: Lens' ResetServiceSettingResponse (Maybe ServiceSetting) Source #

The current, effective service setting after calling the ResetServiceSetting API operation.

resetServiceSettingResponse_httpStatus :: Lens' ResetServiceSettingResponse Int Source #

The response's http status code.

ResumeSession

resumeSession_sessionId :: Lens' ResumeSession Text Source #

The ID of the disconnected session to resume.

resumeSessionResponse_sessionId :: Lens' ResumeSessionResponse (Maybe Text) Source #

The ID of the session.

resumeSessionResponse_streamUrl :: Lens' ResumeSessionResponse (Maybe Text) Source #

A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the managed node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

resumeSessionResponse_tokenValue :: Lens' ResumeSessionResponse (Maybe Text) Source #

An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.

resumeSessionResponse_httpStatus :: Lens' ResumeSessionResponse Int Source #

The response's http status code.

SendAutomationSignal

sendAutomationSignal_payload :: Lens' SendAutomationSignal (Maybe (HashMap Text [Text])) Source #

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

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

sendAutomationSignal_automationExecutionId :: Lens' SendAutomationSignal Text Source #

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

sendAutomationSignal_signalType :: Lens' SendAutomationSignal SignalType Source #

The type of signal to send to an Automation execution.

sendAutomationSignalResponse_httpStatus :: Lens' SendAutomationSignalResponse Int Source #

The response's http status code.

SendCommand

sendCommand_alarmConfiguration :: Lens' SendCommand (Maybe AlarmConfiguration) Source #

The CloudWatch alarm you want to apply to your command.

sendCommand_cloudWatchOutputConfig :: Lens' SendCommand (Maybe CloudWatchOutputConfig) Source #

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

sendCommand_comment :: Lens' SendCommand (Maybe Text) Source #

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

sendCommand_documentHash :: Lens' SendCommand (Maybe Text) Source #

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

Sha1 hashes have been deprecated.

sendCommand_documentHashType :: Lens' SendCommand (Maybe DocumentHashType) Source #

Sha256 or Sha1.

Sha1 hashes have been deprecated.

sendCommand_documentVersion :: Lens' SendCommand (Maybe Text) Source #

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

-document-version "\$DEFAULT"
-document-version "\$LATEST"
-document-version "3"

sendCommand_instanceIds :: Lens' SendCommand (Maybe [Text]) Source #

The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.

To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

sendCommand_maxConcurrency :: Lens' SendCommand (Maybe Text) Source #

(Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

sendCommand_maxErrors :: Lens' SendCommand (Maybe Text) Source #

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

sendCommand_notificationConfig :: Lens' SendCommand (Maybe NotificationConfig) Source #

Configurations for sending notifications.

sendCommand_outputS3BucketName :: Lens' SendCommand (Maybe Text) Source #

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

sendCommand_outputS3KeyPrefix :: Lens' SendCommand (Maybe Text) Source #

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

sendCommand_outputS3Region :: Lens' SendCommand (Maybe Text) Source #

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

sendCommand_parameters :: Lens' SendCommand (Maybe (HashMap Text [Text])) Source #

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

sendCommand_serviceRoleArn :: Lens' SendCommand (Maybe Text) Source #

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

This role must provide the sns:Publish permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

sendCommand_targets :: Lens' SendCommand (Maybe [Target]) Source #

An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.

To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

sendCommand_timeoutSeconds :: Lens' SendCommand (Maybe Natural) Source #

If this time is reached and the command hasn't already started running, it won't run.

sendCommand_documentName :: Lens' SendCommand Text Source #

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument error.

sendCommandResponse_command :: Lens' SendCommandResponse (Maybe Command) Source #

The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.

sendCommandResponse_httpStatus :: Lens' SendCommandResponse Int Source #

The response's http status code.

StartAssociationsOnce

startAssociationsOnce_associationIds :: Lens' StartAssociationsOnce (NonEmpty Text) Source #

The association IDs that you want to run immediately and only one time.

startAssociationsOnceResponse_httpStatus :: Lens' StartAssociationsOnceResponse Int Source #

The response's http status code.

StartAutomationExecution

startAutomationExecution_alarmConfiguration :: Lens' StartAutomationExecution (Maybe AlarmConfiguration) Source #

The CloudWatch alarm you want to apply to your automation.

startAutomationExecution_clientToken :: Lens' StartAutomationExecution (Maybe Text) Source #

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

startAutomationExecution_documentVersion :: Lens' StartAutomationExecution (Maybe Text) Source #

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

startAutomationExecution_maxConcurrency :: Lens' StartAutomationExecution (Maybe Text) Source #

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

startAutomationExecution_maxErrors :: Lens' StartAutomationExecution (Maybe Text) Source #

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

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

startAutomationExecution_mode :: Lens' StartAutomationExecution (Maybe ExecutionMode) Source #

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

startAutomationExecution_parameters :: Lens' StartAutomationExecution (Maybe (HashMap Text [Text])) Source #

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

startAutomationExecution_tags :: Lens' StartAutomationExecution (Maybe [Tag]) Source #

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

```
Key=environment,Value=test
```
```
Key=OS,Value=Windows
```

To add tags to an existing automation, use the AddTagsToResource operation.

startAutomationExecution_targetLocations :: Lens' StartAutomationExecution (Maybe (NonEmpty TargetLocation)) Source #

A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.

startAutomationExecution_targetMaps :: Lens' StartAutomationExecution (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

startAutomationExecution_targetParameterName :: Lens' StartAutomationExecution (Maybe Text) Source #

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

startAutomationExecution_targets :: Lens' StartAutomationExecution (Maybe [Target]) Source #

A key-value mapping to target resources. Required if you specify TargetParameterName.

startAutomationExecution_documentName :: Lens' StartAutomationExecution Text Source #

The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

startAutomationExecutionResponse_automationExecutionId :: Lens' StartAutomationExecutionResponse (Maybe Text) Source #

The unique ID of a newly scheduled automation execution.

startAutomationExecutionResponse_httpStatus :: Lens' StartAutomationExecutionResponse Int Source #

The response's http status code.

StartChangeRequestExecution

startChangeRequestExecution_autoApprove :: Lens' StartChangeRequestExecution (Maybe Bool) Source #

Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

startChangeRequestExecution_changeDetails :: Lens' StartChangeRequestExecution (Maybe Text) Source #

User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

startChangeRequestExecution_changeRequestName :: Lens' StartChangeRequestExecution (Maybe Text) Source #

The name of the change request associated with the runbook workflow to be run.

startChangeRequestExecution_clientToken :: Lens' StartChangeRequestExecution (Maybe Text) Source #

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

startChangeRequestExecution_documentVersion :: Lens' StartChangeRequestExecution (Maybe Text) Source #

The version of the change template document to run during the runbook workflow.

startChangeRequestExecution_parameters :: Lens' StartChangeRequestExecution (Maybe (HashMap Text [Text])) Source #

A key-value map of parameters that match the declared parameters in the change template document.

startChangeRequestExecution_scheduledEndTime :: Lens' StartChangeRequestExecution (Maybe UTCTime) Source #

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

startChangeRequestExecution_scheduledTime :: Lens' StartChangeRequestExecution (Maybe UTCTime) Source #

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

startChangeRequestExecution_tags :: Lens' StartChangeRequestExecution (Maybe [Tag]) Source #

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

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

startChangeRequestExecution_documentName :: Lens' StartChangeRequestExecution Text Source #

The name of the change template document to run during the runbook workflow.

startChangeRequestExecution_runbooks :: Lens' StartChangeRequestExecution (NonEmpty Runbook) Source #

Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

startChangeRequestExecutionResponse_automationExecutionId :: Lens' StartChangeRequestExecutionResponse (Maybe Text) Source #

The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)

startChangeRequestExecutionResponse_httpStatus :: Lens' StartChangeRequestExecutionResponse Int Source #

The response's http status code.

StartSession

startSession_documentName :: Lens' StartSession (Maybe Text) Source #

The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.

startSession_parameters :: Lens' StartSession (Maybe (HashMap Text [Text])) Source #

The values you want to specify for the parameters defined in the Session document.

startSession_reason :: Lens' StartSession (Maybe Text) Source #

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

startSession_target :: Lens' StartSession Text Source #

The managed node to connect to for the session.

startSessionResponse_sessionId :: Lens' StartSessionResponse (Maybe Text) Source #

The ID of the session.

startSessionResponse_streamUrl :: Lens' StartSessionResponse (Maybe Text) Source #

A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

startSessionResponse_tokenValue :: Lens' StartSessionResponse (Maybe Text) Source #

An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session's token.

startSessionResponse_httpStatus :: Lens' StartSessionResponse Int Source #

The response's http status code.

StopAutomationExecution

stopAutomationExecution_type :: Lens' StopAutomationExecution (Maybe StopType) Source #

The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.

stopAutomationExecution_automationExecutionId :: Lens' StopAutomationExecution Text Source #

The execution ID of the Automation to stop.

stopAutomationExecutionResponse_httpStatus :: Lens' StopAutomationExecutionResponse Int Source #

The response's http status code.

TerminateSession

terminateSession_sessionId :: Lens' TerminateSession Text Source #

The ID of the session to terminate.

terminateSessionResponse_sessionId :: Lens' TerminateSessionResponse (Maybe Text) Source #

The ID of the session that has been terminated.

terminateSessionResponse_httpStatus :: Lens' TerminateSessionResponse Int Source #

The response's http status code.

UnlabelParameterVersion

unlabelParameterVersion_name :: Lens' UnlabelParameterVersion Text Source #

The name of the parameter from which you want to delete one or more labels.

unlabelParameterVersion_parameterVersion :: Lens' UnlabelParameterVersion Integer Source #

The specific version of the parameter which you want to delete one or more labels from. If it isn't present, the call will fail.

unlabelParameterVersion_labels :: Lens' UnlabelParameterVersion (NonEmpty Text) Source #

One or more labels to delete from the specified parameter version.

unlabelParameterVersionResponse_invalidLabels :: Lens' UnlabelParameterVersionResponse (Maybe (NonEmpty Text)) Source #

The labels that aren't attached to the given parameter version.

unlabelParameterVersionResponse_removedLabels :: Lens' UnlabelParameterVersionResponse (Maybe (NonEmpty Text)) Source #

A list of all labels deleted from the parameter.

unlabelParameterVersionResponse_httpStatus :: Lens' UnlabelParameterVersionResponse Int Source #

The response's http status code.

UpdateAssociation

updateAssociation_alarmConfiguration :: Lens' UpdateAssociation (Maybe AlarmConfiguration) Source #

Undocumented member.

updateAssociation_applyOnlyAtCronInterval :: Lens' UpdateAssociation (Maybe Bool) Source #

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

If you chose this option when you created an association and later you edit that association or you make changes to the SSM document on which that association is based (by using the Documents page in the console), State Manager applies the association at the next specified cron interval. For example, if you chose the Latest version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously selected this option. If this option wasn't selected, State Manager immediately runs the association.

You can reset this option. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

updateAssociation_associationName :: Lens' UpdateAssociation (Maybe Text) Source #

The name of the association that you want to update.

updateAssociation_associationVersion :: Lens' UpdateAssociation (Maybe Text) Source #

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.

updateAssociation_automationTargetParameterName :: Lens' UpdateAssociation (Maybe Text) Source #

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

updateAssociation_calendarNames :: Lens' UpdateAssociation (Maybe [Text]) Source #

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

updateAssociation_complianceSeverity :: Lens' UpdateAssociation (Maybe AssociationComplianceSeverity) Source #

The severity level to assign to the association.

updateAssociation_documentVersion :: Lens' UpdateAssociation (Maybe Text) Source #

The document version you want update for the association.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

updateAssociation_maxConcurrency :: Lens' UpdateAssociation (Maybe Text) Source #

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

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

updateAssociation_maxErrors :: Lens' UpdateAssociation (Maybe Text) Source #

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

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

updateAssociation_name :: Lens' UpdateAssociation (Maybe Text) Source #

The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.

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

For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:

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

For example:

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

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

updateAssociation_outputLocation :: Lens' UpdateAssociation (Maybe InstanceAssociationOutputLocation) Source #

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

updateAssociation_parameters :: Lens' UpdateAssociation (Maybe (HashMap Text [Text])) Source #

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

updateAssociation_scheduleExpression :: Lens' UpdateAssociation (Maybe Text) Source #

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

updateAssociation_scheduleOffset :: Lens' UpdateAssociation (Maybe Natural) Source #

Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it.

updateAssociation_syncCompliance :: Lens' UpdateAssociation (Maybe AssociationSyncCompliance) Source #

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

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

updateAssociation_targetLocations :: Lens' UpdateAssociation (Maybe (NonEmpty TargetLocation)) Source #

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.

updateAssociation_targetMaps :: Lens' UpdateAssociation (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

updateAssociation_targets :: Lens' UpdateAssociation (Maybe [Target]) Source #

The targets of the association.

updateAssociation_associationId :: Lens' UpdateAssociation Text Source #

The ID of the association you want to update.

updateAssociationResponse_associationDescription :: Lens' UpdateAssociationResponse (Maybe AssociationDescription) Source #

The description of the association that was updated.

updateAssociationResponse_httpStatus :: Lens' UpdateAssociationResponse Int Source #

The response's http status code.

UpdateAssociationStatus

updateAssociationStatus_name :: Lens' UpdateAssociationStatus Text Source #

The name of the SSM document.

updateAssociationStatus_instanceId :: Lens' UpdateAssociationStatus Text Source #

The managed node ID.

updateAssociationStatus_associationStatus :: Lens' UpdateAssociationStatus AssociationStatus Source #

The association status.

updateAssociationStatusResponse_associationDescription :: Lens' UpdateAssociationStatusResponse (Maybe AssociationDescription) Source #

Information about the association.

updateAssociationStatusResponse_httpStatus :: Lens' UpdateAssociationStatusResponse Int Source #

The response's http status code.

UpdateDocument

updateDocument_attachments :: Lens' UpdateDocument (Maybe [AttachmentsSource]) Source #

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

updateDocument_displayName :: Lens' UpdateDocument (Maybe Text) Source #

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

updateDocument_documentFormat :: Lens' UpdateDocument (Maybe DocumentFormat) Source #

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

updateDocument_documentVersion :: Lens' UpdateDocument (Maybe Text) Source #

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

updateDocument_targetType :: Lens' UpdateDocument (Maybe Text) Source #

Specify a new target type for the document.

updateDocument_versionName :: Lens' UpdateDocument (Maybe Text) Source #

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

updateDocument_content :: Lens' UpdateDocument Text Source #

A valid JSON or YAML string.

updateDocument_name :: Lens' UpdateDocument Text Source #

The name of the SSM document that you want to update.

updateDocumentResponse_documentDescription :: Lens' UpdateDocumentResponse (Maybe DocumentDescription) Source #

A description of the document that was updated.

updateDocumentResponse_httpStatus :: Lens' UpdateDocumentResponse Int Source #

The response's http status code.

UpdateDocumentDefaultVersion

updateDocumentDefaultVersion_name :: Lens' UpdateDocumentDefaultVersion Text Source #

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

updateDocumentDefaultVersion_documentVersion :: Lens' UpdateDocumentDefaultVersion Text Source #

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

updateDocumentDefaultVersionResponse_description :: Lens' UpdateDocumentDefaultVersionResponse (Maybe DocumentDefaultVersionDescription) Source #

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

updateDocumentDefaultVersionResponse_httpStatus :: Lens' UpdateDocumentDefaultVersionResponse Int Source #

The response's http status code.

UpdateDocumentMetadata

updateDocumentMetadata_documentVersion :: Lens' UpdateDocumentMetadata (Maybe Text) Source #

The version of a change template in which to update approval metadata.

updateDocumentMetadata_name :: Lens' UpdateDocumentMetadata Text Source #

The name of the change template for which a version's metadata is to be updated.

updateDocumentMetadata_documentReviews :: Lens' UpdateDocumentMetadata DocumentReviews Source #

The change template review details to update.

updateDocumentMetadataResponse_httpStatus :: Lens' UpdateDocumentMetadataResponse Int Source #

The response's http status code.

UpdateMaintenanceWindow

updateMaintenanceWindow_allowUnassociatedTargets :: Lens' UpdateMaintenanceWindow (Maybe Bool) Source #

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

updateMaintenanceWindow_cutoff :: Lens' UpdateMaintenanceWindow (Maybe Natural) Source #

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

updateMaintenanceWindow_description :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #

An optional description for the update request.

updateMaintenanceWindow_duration :: Lens' UpdateMaintenanceWindow (Maybe Natural) Source #

The duration of the maintenance window in hours.

updateMaintenanceWindow_enabled :: Lens' UpdateMaintenanceWindow (Maybe Bool) Source #

Whether the maintenance window is enabled.

updateMaintenanceWindow_endDate :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #

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

updateMaintenanceWindow_name :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #

The name of the maintenance window.

updateMaintenanceWindow_replace :: Lens' UpdateMaintenanceWindow (Maybe Bool) Source #

If True, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

updateMaintenanceWindow_schedule :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #

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

updateMaintenanceWindow_scheduleOffset :: Lens' UpdateMaintenanceWindow (Maybe Natural) Source #

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

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

cron(30 23 ? * TUE#3 *)

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

updateMaintenanceWindow_scheduleTimezone :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #

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

updateMaintenanceWindow_startDate :: Lens' UpdateMaintenanceWindow (Maybe Text) Source #

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

updateMaintenanceWindow_windowId :: Lens' UpdateMaintenanceWindow Text Source #

The ID of the maintenance window to update.

updateMaintenanceWindowResponse_allowUnassociatedTargets :: Lens' UpdateMaintenanceWindowResponse (Maybe Bool) Source #

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

updateMaintenanceWindowResponse_cutoff :: Lens' UpdateMaintenanceWindowResponse (Maybe Natural) Source #

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

updateMaintenanceWindowResponse_description :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #

An optional description of the update.

updateMaintenanceWindowResponse_duration :: Lens' UpdateMaintenanceWindowResponse (Maybe Natural) Source #

The duration of the maintenance window in hours.

updateMaintenanceWindowResponse_enabled :: Lens' UpdateMaintenanceWindowResponse (Maybe Bool) Source #

Whether the maintenance window is enabled.

updateMaintenanceWindowResponse_endDate :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #

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

updateMaintenanceWindowResponse_name :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #

The name of the maintenance window.

updateMaintenanceWindowResponse_schedule :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #

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

updateMaintenanceWindowResponse_scheduleOffset :: Lens' UpdateMaintenanceWindowResponse (Maybe Natural) Source #

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

updateMaintenanceWindowResponse_scheduleTimezone :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #

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

updateMaintenanceWindowResponse_startDate :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #

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

updateMaintenanceWindowResponse_windowId :: Lens' UpdateMaintenanceWindowResponse (Maybe Text) Source #

The ID of the created maintenance window.

updateMaintenanceWindowResponse_httpStatus :: Lens' UpdateMaintenanceWindowResponse Int Source #

The response's http status code.

UpdateMaintenanceWindowTarget

updateMaintenanceWindowTarget_description :: Lens' UpdateMaintenanceWindowTarget (Maybe Text) Source #

An optional description for the update.

updateMaintenanceWindowTarget_name :: Lens' UpdateMaintenanceWindowTarget (Maybe Text) Source #

A name for the update.

updateMaintenanceWindowTarget_ownerInformation :: Lens' UpdateMaintenanceWindowTarget (Maybe Text) Source #

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

updateMaintenanceWindowTarget_replace :: Lens' UpdateMaintenanceWindowTarget (Maybe Bool) Source #

If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

updateMaintenanceWindowTarget_targets :: Lens' UpdateMaintenanceWindowTarget (Maybe [Target]) Source #

The targets to add or replace.

updateMaintenanceWindowTarget_windowId :: Lens' UpdateMaintenanceWindowTarget Text Source #

The maintenance window ID with which to modify the target.

updateMaintenanceWindowTarget_windowTargetId :: Lens' UpdateMaintenanceWindowTarget Text Source #

The target ID to modify.

updateMaintenanceWindowTargetResponse_description :: Lens' UpdateMaintenanceWindowTargetResponse (Maybe Text) Source #

The updated description.

updateMaintenanceWindowTargetResponse_name :: Lens' UpdateMaintenanceWindowTargetResponse (Maybe Text) Source #

The updated name.

updateMaintenanceWindowTargetResponse_ownerInformation :: Lens' UpdateMaintenanceWindowTargetResponse (Maybe Text) Source #

The updated owner.

updateMaintenanceWindowTargetResponse_targets :: Lens' UpdateMaintenanceWindowTargetResponse (Maybe [Target]) Source #

The updated targets.

updateMaintenanceWindowTargetResponse_windowId :: Lens' UpdateMaintenanceWindowTargetResponse (Maybe Text) Source #

The maintenance window ID specified in the update request.

updateMaintenanceWindowTargetResponse_windowTargetId :: Lens' UpdateMaintenanceWindowTargetResponse (Maybe Text) Source #

The target ID specified in the update request.

updateMaintenanceWindowTargetResponse_httpStatus :: Lens' UpdateMaintenanceWindowTargetResponse Int Source #

The response's http status code.

UpdateMaintenanceWindowTask

updateMaintenanceWindowTask_alarmConfiguration :: Lens' UpdateMaintenanceWindowTask (Maybe AlarmConfiguration) Source #

The CloudWatch alarm you want to apply to your maintenance window task.

updateMaintenanceWindowTask_cutoffBehavior :: Lens' UpdateMaintenanceWindowTask (Maybe MaintenanceWindowTaskCutoffBehavior) Source #

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.
CANCEL_TASK:
- For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
- For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
The status for tasks that are not completed is TIMED_OUT.

updateMaintenanceWindowTask_description :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

The new task description to specify.

updateMaintenanceWindowTask_loggingInfo :: Lens' UpdateMaintenanceWindowTask (Maybe LoggingInfo) Source #

The new logging location in Amazon S3 to specify.

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

updateMaintenanceWindowTask_maxConcurrency :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task, in parallel.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

updateMaintenanceWindowTask_maxErrors :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

updateMaintenanceWindowTask_name :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

The new task name to specify.

updateMaintenanceWindowTask_priority :: Lens' UpdateMaintenanceWindowTask (Maybe Natural) Source #

The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

updateMaintenanceWindowTask_replace :: Lens' UpdateMaintenanceWindowTask (Maybe Bool) Source #

If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

updateMaintenanceWindowTask_serviceRoleArn :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the /Amazon Web Services Systems Manager User Guide/:

updateMaintenanceWindowTask_targets :: Lens' UpdateMaintenanceWindowTask (Maybe [Target]) Source #

The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using the format Key=tag_name,Values=tag_value.

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

updateMaintenanceWindowTask_taskArn :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

The task ARN to modify.

updateMaintenanceWindowTask_taskInvocationParameters :: Lens' UpdateMaintenanceWindowTask (Maybe MaintenanceWindowTaskInvocationParameters) Source #

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

When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

updateMaintenanceWindowTask_taskParameters :: Lens' UpdateMaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #

The parameters to modify.

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

The map has the following format:

Key: string, between 1 and 255 characters

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

updateMaintenanceWindowTask_windowId :: Lens' UpdateMaintenanceWindowTask Text Source #

The maintenance window ID that contains the task to modify.

updateMaintenanceWindowTask_windowTaskId :: Lens' UpdateMaintenanceWindowTask Text Source #

The task ID to modify.

updateMaintenanceWindowTaskResponse_alarmConfiguration :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe AlarmConfiguration) Source #

The details for the CloudWatch alarm you applied to your maintenance window task.

updateMaintenanceWindowTaskResponse_cutoffBehavior :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskCutoffBehavior) Source #

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

updateMaintenanceWindowTaskResponse_description :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated task description.

updateMaintenanceWindowTaskResponse_loggingInfo :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe LoggingInfo) Source #

The updated logging information in Amazon S3.

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

updateMaintenanceWindowTaskResponse_maxConcurrency :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated MaxConcurrency value.

updateMaintenanceWindowTaskResponse_maxErrors :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated MaxErrors value.

updateMaintenanceWindowTaskResponse_name :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated task name.

updateMaintenanceWindowTaskResponse_priority :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Natural) Source #

The updated priority value.

updateMaintenanceWindowTaskResponse_serviceRoleArn :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

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

updateMaintenanceWindowTaskResponse_targets :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe [Target]) Source #

The updated target values.

updateMaintenanceWindowTaskResponse_taskArn :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated task ARN value.

updateMaintenanceWindowTaskResponse_taskInvocationParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskInvocationParameters) Source #

The updated parameter values.

updateMaintenanceWindowTaskResponse_taskParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #

The updated parameter values.

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

updateMaintenanceWindowTaskResponse_windowId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The ID of the maintenance window that was updated.

updateMaintenanceWindowTaskResponse_windowTaskId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The task ID of the maintenance window that was updated.

updateMaintenanceWindowTaskResponse_httpStatus :: Lens' UpdateMaintenanceWindowTaskResponse Int Source #

The response's http status code.

UpdateManagedInstanceRole

updateManagedInstanceRole_instanceId :: Lens' UpdateManagedInstanceRole Text Source #

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

updateManagedInstanceRole_iamRole :: Lens' UpdateManagedInstanceRole Text Source #

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

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

updateManagedInstanceRoleResponse_httpStatus :: Lens' UpdateManagedInstanceRoleResponse Int Source #

The response's http status code.

UpdateOpsItem

updateOpsItem_actualEndTime :: Lens' UpdateOpsItem (Maybe UTCTime) Source #

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

updateOpsItem_actualStartTime :: Lens' UpdateOpsItem (Maybe UTCTime) Source #

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

updateOpsItem_category :: Lens' UpdateOpsItem (Maybe Text) Source #

Specify a new category for an OpsItem.

updateOpsItem_description :: Lens' UpdateOpsItem (Maybe Text) Source #

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

updateOpsItem_notifications :: Lens' UpdateOpsItem (Maybe [OpsItemNotification]) Source #

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

updateOpsItem_operationalData :: Lens' UpdateOpsItem (Maybe (HashMap Text OpsItemDataValue)) Source #

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

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

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

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

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

updateOpsItem_operationalDataToDelete :: Lens' UpdateOpsItem (Maybe [Text]) Source #

Keys that you want to remove from the OperationalData map.

updateOpsItem_opsItemArn :: Lens' UpdateOpsItem (Maybe Text) Source #

The OpsItem Amazon Resource Name (ARN).

updateOpsItem_plannedEndTime :: Lens' UpdateOpsItem (Maybe UTCTime) Source #

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

updateOpsItem_plannedStartTime :: Lens' UpdateOpsItem (Maybe UTCTime) Source #

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

updateOpsItem_priority :: Lens' UpdateOpsItem (Maybe Natural) Source #

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

updateOpsItem_relatedOpsItems :: Lens' UpdateOpsItem (Maybe [RelatedOpsItem]) Source #

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

updateOpsItem_severity :: Lens' UpdateOpsItem (Maybe Text) Source #

Specify a new severity for an OpsItem.

updateOpsItem_status :: Lens' UpdateOpsItem (Maybe OpsItemStatus) Source #

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

updateOpsItem_title :: Lens' UpdateOpsItem (Maybe Text) Source #

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

updateOpsItem_opsItemId :: Lens' UpdateOpsItem Text Source #

The ID of the OpsItem.

updateOpsItemResponse_httpStatus :: Lens' UpdateOpsItemResponse Int Source #

The response's http status code.

UpdateOpsMetadata

updateOpsMetadata_keysToDelete :: Lens' UpdateOpsMetadata (Maybe (NonEmpty Text)) Source #

The metadata keys to delete from the OpsMetadata object.

updateOpsMetadata_metadataToUpdate :: Lens' UpdateOpsMetadata (Maybe (HashMap Text MetadataValue)) Source #

Metadata to add to an OpsMetadata object.

updateOpsMetadata_opsMetadataArn :: Lens' UpdateOpsMetadata Text Source #

The Amazon Resource Name (ARN) of the OpsMetadata Object to update.

updateOpsMetadataResponse_opsMetadataArn :: Lens' UpdateOpsMetadataResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.

updateOpsMetadataResponse_httpStatus :: Lens' UpdateOpsMetadataResponse Int Source #

The response's http status code.

UpdatePatchBaseline

updatePatchBaseline_approvalRules :: Lens' UpdatePatchBaseline (Maybe PatchRuleGroup) Source #

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

updatePatchBaseline_approvedPatches :: Lens' UpdatePatchBaseline (Maybe [Text]) Source #

A list of explicitly approved patches for the baseline.

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

updatePatchBaseline_approvedPatchesComplianceLevel :: Lens' UpdatePatchBaseline (Maybe PatchComplianceLevel) Source #

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

updatePatchBaseline_approvedPatchesEnableNonSecurity :: Lens' UpdatePatchBaseline (Maybe Bool) Source #

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

updatePatchBaseline_description :: Lens' UpdatePatchBaseline (Maybe Text) Source #

A description of the patch baseline.

updatePatchBaseline_globalFilters :: Lens' UpdatePatchBaseline (Maybe PatchFilterGroup) Source #

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

updatePatchBaseline_name :: Lens' UpdatePatchBaseline (Maybe Text) Source #

The name of the patch baseline.

updatePatchBaseline_rejectedPatches :: Lens' UpdatePatchBaseline (Maybe [Text]) Source #

A list of explicitly rejected patches for the baseline.

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

updatePatchBaseline_rejectedPatchesAction :: Lens' UpdatePatchBaseline (Maybe PatchAction) Source #

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

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

updatePatchBaseline_replace :: Lens' UpdatePatchBaseline (Maybe Bool) Source #

If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.

updatePatchBaseline_sources :: Lens' UpdatePatchBaseline (Maybe [PatchSource]) Source #

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

updatePatchBaseline_baselineId :: Lens' UpdatePatchBaseline Text Source #

The ID of the patch baseline to update.

updatePatchBaselineResponse_approvalRules :: Lens' UpdatePatchBaselineResponse (Maybe PatchRuleGroup) Source #

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

updatePatchBaselineResponse_approvedPatches :: Lens' UpdatePatchBaselineResponse (Maybe [Text]) Source #

A list of explicitly approved patches for the baseline.

updatePatchBaselineResponse_approvedPatchesComplianceLevel :: Lens' UpdatePatchBaselineResponse (Maybe PatchComplianceLevel) Source #

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

updatePatchBaselineResponse_approvedPatchesEnableNonSecurity :: Lens' UpdatePatchBaselineResponse (Maybe Bool) Source #

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

updatePatchBaselineResponse_baselineId :: Lens' UpdatePatchBaselineResponse (Maybe Text) Source #

The ID of the deleted patch baseline.

updatePatchBaselineResponse_createdDate :: Lens' UpdatePatchBaselineResponse (Maybe UTCTime) Source #

The date when the patch baseline was created.

updatePatchBaselineResponse_description :: Lens' UpdatePatchBaselineResponse (Maybe Text) Source #

A description of the patch baseline.

updatePatchBaselineResponse_globalFilters :: Lens' UpdatePatchBaselineResponse (Maybe PatchFilterGroup) Source #

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

updatePatchBaselineResponse_modifiedDate :: Lens' UpdatePatchBaselineResponse (Maybe UTCTime) Source #

The date when the patch baseline was last modified.

updatePatchBaselineResponse_name :: Lens' UpdatePatchBaselineResponse (Maybe Text) Source #

The name of the patch baseline.

updatePatchBaselineResponse_operatingSystem :: Lens' UpdatePatchBaselineResponse (Maybe OperatingSystem) Source #

The operating system rule used by the updated patch baseline.

updatePatchBaselineResponse_rejectedPatches :: Lens' UpdatePatchBaselineResponse (Maybe [Text]) Source #

A list of explicitly rejected patches for the baseline.

updatePatchBaselineResponse_rejectedPatchesAction :: Lens' UpdatePatchBaselineResponse (Maybe PatchAction) Source #

The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

updatePatchBaselineResponse_sources :: Lens' UpdatePatchBaselineResponse (Maybe [PatchSource]) Source #

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

updatePatchBaselineResponse_httpStatus :: Lens' UpdatePatchBaselineResponse Int Source #

The response's http status code.

UpdateResourceDataSync

updateResourceDataSync_syncName :: Lens' UpdateResourceDataSync Text Source #

The name of the resource data sync you want to update.

updateResourceDataSync_syncType :: Lens' UpdateResourceDataSync Text Source #

The type of resource data sync. The supported SyncType is SyncFromSource.

updateResourceDataSync_syncSource :: Lens' UpdateResourceDataSync ResourceDataSyncSource Source #

Specify information about the data sources to synchronize.

updateResourceDataSyncResponse_httpStatus :: Lens' UpdateResourceDataSyncResponse Int Source #

The response's http status code.

UpdateServiceSetting

updateServiceSetting_settingId :: Lens' UpdateServiceSetting Text Source #

The Amazon Resource Name (ARN) of the service setting to reset. For example, arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled. The setting ID can be one of the following.

/ssm/automation/customer-script-log-destination

/ssm/automation/customer-script-log-group-name

/ssm/documents/console/public-sharing-permission

```
/ssm/managed-instance/activation-tier
```
```
/ssm/opsinsights/opscenter
```

/ssm/parameter-store/default-parameter-tier

/ssm/parameter-store/high-throughput-enabled

updateServiceSetting_settingValue :: Lens' UpdateServiceSetting Text Source #

The new value to specify for the service setting. The following list specifies the available values for each setting.

/ssm/automation/customer-script-log-destination: CloudWatch
/ssm/automation/customer-script-log-group-name: the name of an Amazon CloudWatch Logs log group
/ssm/documents/console/public-sharing-permission: Enable or Disable
/ssm/managed-instance/activation-tier: standard or advanced
/ssm/opsinsights/opscenter: Enabled or Disabled
/ssm/parameter-store/default-parameter-tier: Standard, Advanced, Intelligent-Tiering
/ssm/parameter-store/high-throughput-enabled: true or false

updateServiceSettingResponse_httpStatus :: Lens' UpdateServiceSettingResponse Int Source #

The response's http status code.

Types

AccountSharingInfo

accountSharingInfo_accountId :: Lens' AccountSharingInfo (Maybe Text) Source #

The Amazon Web Services account ID where the current document is shared.

accountSharingInfo_sharedDocumentVersion :: Lens' AccountSharingInfo (Maybe Text) Source #

The version of the current document shared with the account.

Activation

activation_activationId :: Lens' Activation (Maybe Text) Source #

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

activation_createdDate :: Lens' Activation (Maybe UTCTime) Source #

The date the activation was created.

activation_defaultInstanceName :: Lens' Activation (Maybe Text) Source #

A name for the managed node when it is created.

activation_description :: Lens' Activation (Maybe Text) Source #

A user defined description of the activation.

activation_expirationDate :: Lens' Activation (Maybe UTCTime) Source #

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

activation_expired :: Lens' Activation (Maybe Bool) Source #

Whether or not the activation is expired.

activation_iamRole :: Lens' Activation (Maybe Text) Source #

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

activation_registrationLimit :: Lens' Activation (Maybe Natural) Source #

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

activation_registrationsCount :: Lens' Activation (Maybe Natural) Source #

The number of managed nodes already registered with this activation.

activation_tags :: Lens' Activation (Maybe [Tag]) Source #

Tags assigned to the activation.

Alarm

alarm_name :: Lens' Alarm Text Source #

The name of your CloudWatch alarm.

AlarmConfiguration

alarmConfiguration_ignorePollAlarmFailure :: Lens' AlarmConfiguration (Maybe Bool) Source #

If you specify true for this value, your automation or command continue to run even if we can't gather information about the state of your CloudWatch alarm. The default value is false.

alarmConfiguration_alarms :: Lens' AlarmConfiguration (NonEmpty Alarm) Source #

The name of the CloudWatch alarm specified in the configuration.

AlarmStateInformation

alarmStateInformation_name :: Lens' AlarmStateInformation Text Source #

The name of your CloudWatch alarm.

alarmStateInformation_state :: Lens' AlarmStateInformation ExternalAlarmState Source #

The state of your CloudWatch alarm.

Association

association_associationId :: Lens' Association (Maybe Text) Source #

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

association_associationName :: Lens' Association (Maybe Text) Source #

The association name.

association_associationVersion :: Lens' Association (Maybe Text) Source #

The association version.

association_documentVersion :: Lens' Association (Maybe Text) Source #

The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

association_instanceId :: Lens' Association (Maybe Text) Source #

The managed node ID.

association_lastExecutionDate :: Lens' Association (Maybe UTCTime) Source #

The date on which the association was last run.

association_name :: Lens' Association (Maybe Text) Source #

The name of the SSM document.

association_overview :: Lens' Association (Maybe AssociationOverview) Source #

Information about the association.

association_scheduleExpression :: Lens' Association (Maybe Text) Source #

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

association_scheduleOffset :: Lens' Association (Maybe Natural) Source #

Number of days to wait after the scheduled day to run an association.

association_targetMaps :: Lens' Association (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

association_targets :: Lens' Association (Maybe [Target]) Source #

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

AssociationDescription

associationDescription_alarmConfiguration :: Lens' AssociationDescription (Maybe AlarmConfiguration) Source #

Undocumented member.

associationDescription_applyOnlyAtCronInterval :: Lens' AssociationDescription (Maybe Bool) Source #

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

associationDescription_associationId :: Lens' AssociationDescription (Maybe Text) Source #

The association ID.

associationDescription_associationName :: Lens' AssociationDescription (Maybe Text) Source #

The association name.

associationDescription_associationVersion :: Lens' AssociationDescription (Maybe Text) Source #

The association version.

associationDescription_automationTargetParameterName :: Lens' AssociationDescription (Maybe Text) Source #

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

associationDescription_calendarNames :: Lens' AssociationDescription (Maybe [Text]) Source #

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

associationDescription_complianceSeverity :: Lens' AssociationDescription (Maybe AssociationComplianceSeverity) Source #

The severity level that is assigned to the association.

associationDescription_date :: Lens' AssociationDescription (Maybe UTCTime) Source #

The date when the association was made.

associationDescription_documentVersion :: Lens' AssociationDescription (Maybe Text) Source #

The document version.

associationDescription_instanceId :: Lens' AssociationDescription (Maybe Text) Source #

The managed node ID.

associationDescription_lastExecutionDate :: Lens' AssociationDescription (Maybe UTCTime) Source #

The date on which the association was last run.

associationDescription_lastSuccessfulExecutionDate :: Lens' AssociationDescription (Maybe UTCTime) Source #

The last date on which the association was successfully run.

associationDescription_lastUpdateAssociationDate :: Lens' AssociationDescription (Maybe UTCTime) Source #

The date when the association was last updated.

associationDescription_maxConcurrency :: Lens' AssociationDescription (Maybe Text) Source #

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

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

associationDescription_maxErrors :: Lens' AssociationDescription (Maybe Text) Source #

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

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

associationDescription_name :: Lens' AssociationDescription (Maybe Text) Source #

The name of the SSM document.

associationDescription_outputLocation :: Lens' AssociationDescription (Maybe InstanceAssociationOutputLocation) Source #

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

associationDescription_overview :: Lens' AssociationDescription (Maybe AssociationOverview) Source #

Information about the association.

associationDescription_parameters :: Lens' AssociationDescription (Maybe (HashMap Text [Text])) Source #

A description of the parameters for a document.

associationDescription_scheduleExpression :: Lens' AssociationDescription (Maybe Text) Source #

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

associationDescription_scheduleOffset :: Lens' AssociationDescription (Maybe Natural) Source #

Number of days to wait after the scheduled day to run an association.

associationDescription_status :: Lens' AssociationDescription (Maybe AssociationStatus) Source #

The association status.

associationDescription_syncCompliance :: Lens' AssociationDescription (Maybe AssociationSyncCompliance) Source #

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

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

associationDescription_targetLocations :: Lens' AssociationDescription (Maybe (NonEmpty TargetLocation)) Source #

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

associationDescription_targetMaps :: Lens' AssociationDescription (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

associationDescription_targets :: Lens' AssociationDescription (Maybe [Target]) Source #

The managed nodes targeted by the request.

associationDescription_triggeredAlarms :: Lens' AssociationDescription (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarm that was invoked during the association.

AssociationExecution

associationExecution_alarmConfiguration :: Lens' AssociationExecution (Maybe AlarmConfiguration) Source #

Undocumented member.

associationExecution_associationId :: Lens' AssociationExecution (Maybe Text) Source #

The association ID.

associationExecution_associationVersion :: Lens' AssociationExecution (Maybe Text) Source #

The association version.

associationExecution_createdTime :: Lens' AssociationExecution (Maybe UTCTime) Source #

The time the execution started.

associationExecution_detailedStatus :: Lens' AssociationExecution (Maybe Text) Source #

Detailed status information about the execution.

associationExecution_executionId :: Lens' AssociationExecution (Maybe Text) Source #

The execution ID for the association.

associationExecution_lastExecutionDate :: Lens' AssociationExecution (Maybe UTCTime) Source #

The date of the last execution.

associationExecution_resourceCountByStatus :: Lens' AssociationExecution (Maybe Text) Source #

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

associationExecution_status :: Lens' AssociationExecution (Maybe Text) Source #

The status of the association execution.

associationExecution_triggeredAlarms :: Lens' AssociationExecution (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarms that were invoked by the association.

AssociationExecutionFilter

associationExecutionFilter_key :: Lens' AssociationExecutionFilter AssociationExecutionFilterKey Source #

The key value used in the request.

associationExecutionFilter_value :: Lens' AssociationExecutionFilter Text Source #

The value specified for the key.

associationExecutionFilter_type :: Lens' AssociationExecutionFilter AssociationFilterOperatorType Source #

The filter type specified in the request.

AssociationExecutionTarget

associationExecutionTarget_associationId :: Lens' AssociationExecutionTarget (Maybe Text) Source #

The association ID.

associationExecutionTarget_associationVersion :: Lens' AssociationExecutionTarget (Maybe Text) Source #

The association version.

associationExecutionTarget_detailedStatus :: Lens' AssociationExecutionTarget (Maybe Text) Source #

Detailed information about the execution status.

associationExecutionTarget_executionId :: Lens' AssociationExecutionTarget (Maybe Text) Source #

The execution ID.

associationExecutionTarget_lastExecutionDate :: Lens' AssociationExecutionTarget (Maybe UTCTime) Source #

The date of the last execution.

associationExecutionTarget_outputSource :: Lens' AssociationExecutionTarget (Maybe OutputSource) Source #

The location where the association details are saved.

associationExecutionTarget_resourceId :: Lens' AssociationExecutionTarget (Maybe Text) Source #

The resource ID, for example, the managed node ID where the association ran.

associationExecutionTarget_resourceType :: Lens' AssociationExecutionTarget (Maybe Text) Source #

The resource type, for example, EC2.

associationExecutionTarget_status :: Lens' AssociationExecutionTarget (Maybe Text) Source #

The association execution status.

AssociationExecutionTargetsFilter

associationExecutionTargetsFilter_key :: Lens' AssociationExecutionTargetsFilter AssociationExecutionTargetsFilterKey Source #

The key value used in the request.

associationExecutionTargetsFilter_value :: Lens' AssociationExecutionTargetsFilter Text Source #

The value specified for the key.

AssociationFilter

associationFilter_key :: Lens' AssociationFilter AssociationFilterKey Source #

The name of the filter.

InstanceId has been deprecated.

associationFilter_value :: Lens' AssociationFilter Text Source #

The filter value.

AssociationOverview

associationOverview_associationStatusAggregatedCount :: Lens' AssociationOverview (Maybe (HashMap Text Int)) Source #

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

associationOverview_detailedStatus :: Lens' AssociationOverview (Maybe Text) Source #

A detailed status of the association.

associationOverview_status :: Lens' AssociationOverview (Maybe Text) Source #

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

AssociationStatus

associationStatus_additionalInfo :: Lens' AssociationStatus (Maybe Text) Source #

A user-defined string.

associationStatus_date :: Lens' AssociationStatus UTCTime Source #

The date when the status changed.

associationStatus_name :: Lens' AssociationStatus AssociationStatusName Source #

The status.

associationStatus_message :: Lens' AssociationStatus Text Source #

The reason for the status.

AssociationVersionInfo

associationVersionInfo_applyOnlyAtCronInterval :: Lens' AssociationVersionInfo (Maybe Bool) Source #

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

associationVersionInfo_associationId :: Lens' AssociationVersionInfo (Maybe Text) Source #

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

associationVersionInfo_associationName :: Lens' AssociationVersionInfo (Maybe Text) Source #

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

associationVersionInfo_associationVersion :: Lens' AssociationVersionInfo (Maybe Text) Source #

The association version.

associationVersionInfo_calendarNames :: Lens' AssociationVersionInfo (Maybe [Text]) Source #

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

associationVersionInfo_complianceSeverity :: Lens' AssociationVersionInfo (Maybe AssociationComplianceSeverity) Source #

The severity level that is assigned to the association.

associationVersionInfo_createdDate :: Lens' AssociationVersionInfo (Maybe UTCTime) Source #

The date the association version was created.

associationVersionInfo_documentVersion :: Lens' AssociationVersionInfo (Maybe Text) Source #

The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.

associationVersionInfo_maxConcurrency :: Lens' AssociationVersionInfo (Maybe Text) Source #

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

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

associationVersionInfo_maxErrors :: Lens' AssociationVersionInfo (Maybe Text) Source #

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

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

associationVersionInfo_name :: Lens' AssociationVersionInfo (Maybe Text) Source #

The name specified when the association was created.

associationVersionInfo_outputLocation :: Lens' AssociationVersionInfo (Maybe InstanceAssociationOutputLocation) Source #

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

associationVersionInfo_parameters :: Lens' AssociationVersionInfo (Maybe (HashMap Text [Text])) Source #

Parameters specified when the association version was created.

associationVersionInfo_scheduleExpression :: Lens' AssociationVersionInfo (Maybe Text) Source #

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

associationVersionInfo_scheduleOffset :: Lens' AssociationVersionInfo (Maybe Natural) Source #

Number of days to wait after the scheduled day to run an association.

associationVersionInfo_syncCompliance :: Lens' AssociationVersionInfo (Maybe AssociationSyncCompliance) Source #

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

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

associationVersionInfo_targetLocations :: Lens' AssociationVersionInfo (Maybe (NonEmpty TargetLocation)) Source #

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.

associationVersionInfo_targetMaps :: Lens' AssociationVersionInfo (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

associationVersionInfo_targets :: Lens' AssociationVersionInfo (Maybe [Target]) Source #

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

AttachmentContent

attachmentContent_hash :: Lens' AttachmentContent (Maybe Text) Source #

The cryptographic hash value of the document content.

attachmentContent_hashType :: Lens' AttachmentContent (Maybe AttachmentHashType) Source #

The hash algorithm used to calculate the hash value.

attachmentContent_name :: Lens' AttachmentContent (Maybe Text) Source #

The name of an attachment.

attachmentContent_size :: Lens' AttachmentContent (Maybe Integer) Source #

The size of an attachment in bytes.

attachmentContent_url :: Lens' AttachmentContent (Maybe Text) Source #

The URL location of the attachment content.

AttachmentInformation

attachmentInformation_name :: Lens' AttachmentInformation (Maybe Text) Source #

The name of the attachment.

AttachmentsSource

attachmentsSource_key :: Lens' AttachmentsSource (Maybe AttachmentsSourceKey) Source #

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

attachmentsSource_name :: Lens' AttachmentsSource (Maybe Text) Source #

The name of the document attachment file.

attachmentsSource_values :: Lens' AttachmentsSource (Maybe (NonEmpty Text)) Source #

The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

For the key SourceUrl, the value is an S3 bucket location. For example:
```
"Values": [ "s3://doc-example-bucket/my-folder" ]
```
For the key S3FileUrl, the value is a file in an S3 bucket. For example:
```
"Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
```
For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
```
"Values": [ "MyOtherDocument/3/my-other-file.py" ]
```
However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
```
"Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
```

AutomationExecution

automationExecution_alarmConfiguration :: Lens' AutomationExecution (Maybe AlarmConfiguration) Source #

The details for the CloudWatch alarm applied to your automation.

automationExecution_associationId :: Lens' AutomationExecution (Maybe Text) Source #

The ID of a State Manager association used in the Automation operation.

automationExecution_automationExecutionId :: Lens' AutomationExecution (Maybe Text) Source #

The execution ID.

automationExecution_automationExecutionStatus :: Lens' AutomationExecution (Maybe AutomationExecutionStatus) Source #

The execution status of the Automation.

automationExecution_automationSubtype :: Lens' AutomationExecution (Maybe AutomationSubtype) Source #

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

automationExecution_changeRequestName :: Lens' AutomationExecution (Maybe Text) Source #

The name of the Change Manager change request.

automationExecution_currentAction :: Lens' AutomationExecution (Maybe Text) Source #

The action of the step that is currently running.

automationExecution_currentStepName :: Lens' AutomationExecution (Maybe Text) Source #

The name of the step that is currently running.

automationExecution_documentName :: Lens' AutomationExecution (Maybe Text) Source #

The name of the Automation runbook used during the execution.

automationExecution_documentVersion :: Lens' AutomationExecution (Maybe Text) Source #

The version of the document to use during execution.

automationExecution_executedBy :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_executionEndTime :: Lens' AutomationExecution (Maybe UTCTime) Source #

The time the execution finished.

automationExecution_executionStartTime :: Lens' AutomationExecution (Maybe UTCTime) Source #

The time the execution started.

automationExecution_failureMessage :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_maxConcurrency :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_maxErrors :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_mode :: Lens' AutomationExecution (Maybe ExecutionMode) Source #

The automation execution mode.

automationExecution_opsItemId :: Lens' AutomationExecution (Maybe Text) Source #

The ID of an OpsItem that is created to represent a Change Manager change request.

automationExecution_outputs :: Lens' AutomationExecution (Maybe (HashMap Text [Text])) Source #

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

automationExecution_parameters :: Lens' AutomationExecution (Maybe (HashMap Text [Text])) Source #

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

automationExecution_parentAutomationExecutionId :: Lens' AutomationExecution (Maybe Text) Source #

The AutomationExecutionId of the parent automation.

automationExecution_progressCounters :: Lens' AutomationExecution (Maybe ProgressCounters) Source #

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

automationExecution_resolvedTargets :: Lens' AutomationExecution (Maybe ResolvedTargets) Source #

A list of resolved targets in the rate control execution.

automationExecution_runbooks :: Lens' AutomationExecution (Maybe (NonEmpty Runbook)) Source #

Information about the Automation runbooks that are run as part of a runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

automationExecution_scheduledTime :: Lens' AutomationExecution (Maybe UTCTime) Source #

The date and time the Automation operation is scheduled to start.

automationExecution_stepExecutions :: Lens' AutomationExecution (Maybe [StepExecution]) Source #

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

automationExecution_stepExecutionsTruncated :: Lens' AutomationExecution (Maybe Bool) Source #

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

automationExecution_target :: Lens' AutomationExecution (Maybe Text) Source #

The target of the execution.

automationExecution_targetLocations :: Lens' AutomationExecution (Maybe (NonEmpty TargetLocation)) Source #

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

automationExecution_targetMaps :: Lens' AutomationExecution (Maybe [HashMap Text [Text]]) Source #

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

automationExecution_targetParameterName :: Lens' AutomationExecution (Maybe Text) Source #

The parameter name.

automationExecution_targets :: Lens' AutomationExecution (Maybe [Target]) Source #

The specified targets.

automationExecution_triggeredAlarms :: Lens' AutomationExecution (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarm that was invoked by the automation.

AutomationExecutionFilter

automationExecutionFilter_key :: Lens' AutomationExecutionFilter AutomationExecutionFilterKey Source #

One or more keys to limit the results.

automationExecutionFilter_values :: Lens' AutomationExecutionFilter (NonEmpty Text) Source #

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

AutomationExecutionMetadata

automationExecutionMetadata_alarmConfiguration :: Lens' AutomationExecutionMetadata (Maybe AlarmConfiguration) Source #

The details for the CloudWatch alarm applied to your automation.

automationExecutionMetadata_associationId :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

The ID of a State Manager association used in the Automation operation.

automationExecutionMetadata_automationExecutionId :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

The execution ID.

automationExecutionMetadata_automationExecutionStatus :: Lens' AutomationExecutionMetadata (Maybe AutomationExecutionStatus) Source #

The status of the execution.

automationExecutionMetadata_automationSubtype :: Lens' AutomationExecutionMetadata (Maybe AutomationSubtype) Source #

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

automationExecutionMetadata_automationType :: Lens' AutomationExecutionMetadata (Maybe AutomationType) Source #

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

automationExecutionMetadata_changeRequestName :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

The name of the Change Manager change request.

automationExecutionMetadata_currentAction :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

The action of the step that is currently running.

automationExecutionMetadata_currentStepName :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

The name of the step that is currently running.

automationExecutionMetadata_documentName :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

The name of the Automation runbook used during execution.

automationExecutionMetadata_documentVersion :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

The document version used during the execution.

automationExecutionMetadata_executedBy :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

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

automationExecutionMetadata_executionEndTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime) Source #

The time the execution finished. This isn't populated if the execution is still in progress.

automationExecutionMetadata_executionStartTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime) Source #

The time the execution started.

automationExecutionMetadata_failureMessage :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

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

automationExecutionMetadata_logFile :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

An S3 bucket where execution information is stored.

automationExecutionMetadata_maxConcurrency :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

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

automationExecutionMetadata_maxErrors :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

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

automationExecutionMetadata_mode :: Lens' AutomationExecutionMetadata (Maybe ExecutionMode) Source #

The Automation execution mode.

automationExecutionMetadata_opsItemId :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

The ID of an OpsItem that is created to represent a Change Manager change request.

automationExecutionMetadata_outputs :: Lens' AutomationExecutionMetadata (Maybe (HashMap Text [Text])) Source #

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

automationExecutionMetadata_parentAutomationExecutionId :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

The execution ID of the parent automation.

automationExecutionMetadata_resolvedTargets :: Lens' AutomationExecutionMetadata (Maybe ResolvedTargets) Source #

A list of targets that resolved during the execution.

automationExecutionMetadata_runbooks :: Lens' AutomationExecutionMetadata (Maybe (NonEmpty Runbook)) Source #

Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

automationExecutionMetadata_scheduledTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime) Source #

The date and time the Automation operation is scheduled to start.

automationExecutionMetadata_target :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

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

automationExecutionMetadata_targetMaps :: Lens' AutomationExecutionMetadata (Maybe [HashMap Text [Text]]) Source #

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

automationExecutionMetadata_targetParameterName :: Lens' AutomationExecutionMetadata (Maybe Text) Source #

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

automationExecutionMetadata_targets :: Lens' AutomationExecutionMetadata (Maybe [Target]) Source #

The targets defined by the user when starting the automation.

automationExecutionMetadata_triggeredAlarms :: Lens' AutomationExecutionMetadata (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarm that was invoked by the automation.

BaselineOverride

baselineOverride_approvalRules :: Lens' BaselineOverride (Maybe PatchRuleGroup) Source #

Undocumented member.

baselineOverride_approvedPatches :: Lens' BaselineOverride (Maybe [Text]) Source #

A list of explicitly approved patches for the baseline.

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

baselineOverride_approvedPatchesComplianceLevel :: Lens' BaselineOverride (Maybe PatchComplianceLevel) Source #

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

baselineOverride_approvedPatchesEnableNonSecurity :: Lens' BaselineOverride (Maybe Bool) Source #

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

baselineOverride_globalFilters :: Lens' BaselineOverride (Maybe PatchFilterGroup) Source #

Undocumented member.

baselineOverride_operatingSystem :: Lens' BaselineOverride (Maybe OperatingSystem) Source #

The operating system rule used by the patch baseline override.

baselineOverride_rejectedPatches :: Lens' BaselineOverride (Maybe [Text]) Source #

A list of explicitly rejected patches for the baseline.

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

baselineOverride_rejectedPatchesAction :: Lens' BaselineOverride (Maybe PatchAction) Source #

The action for Patch Manager to take on patches included in the RejectedPackages list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

baselineOverride_sources :: Lens' BaselineOverride (Maybe [PatchSource]) Source #

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

CloudWatchOutputConfig

cloudWatchOutputConfig_cloudWatchLogGroupName :: Lens' CloudWatchOutputConfig (Maybe Text) Source #

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

aws/ssm/SystemsManagerDocumentName

cloudWatchOutputConfig_cloudWatchOutputEnabled :: Lens' CloudWatchOutputConfig (Maybe Bool) Source #

Enables Systems Manager to send command output to CloudWatch Logs.

Command

command_alarmConfiguration :: Lens' Command (Maybe AlarmConfiguration) Source #

The details for the CloudWatch alarm applied to your command.

command_cloudWatchOutputConfig :: Lens' Command (Maybe CloudWatchOutputConfig) Source #

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

command_commandId :: Lens' Command (Maybe Text) Source #

A unique identifier for this command.

command_comment :: Lens' Command (Maybe Text) Source #

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

command_completedCount :: Lens' Command (Maybe Int) Source #

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

command_deliveryTimedOutCount :: Lens' Command (Maybe Int) Source #

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

command_documentName :: Lens' Command (Maybe Text) Source #

The name of the document requested for execution.

command_documentVersion :: Lens' Command (Maybe Text) Source #

The Systems Manager document (SSM document) version.

command_errorCount :: Lens' Command (Maybe Int) Source #

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

command_expiresAfter :: Lens' Command (Maybe UTCTime) Source #

If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.

command_instanceIds :: Lens' Command (Maybe [Text]) Source #

The managed node IDs against which this command was requested.

command_maxConcurrency :: Lens' Command (Maybe Text) Source #

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

command_maxErrors :: Lens' Command (Maybe Text) Source #

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

command_notificationConfig :: Lens' Command (Maybe NotificationConfig) Source #

Configurations for sending notifications about command status changes.

command_outputS3BucketName :: Lens' Command (Maybe Text) Source #

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

command_outputS3KeyPrefix :: Lens' Command (Maybe Text) Source #

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

command_outputS3Region :: Lens' Command (Maybe Text) Source #

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

command_parameters :: Lens' Command (Maybe (HashMap Text [Text])) Source #

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

command_requestedDateTime :: Lens' Command (Maybe UTCTime) Source #

The date and time the command was requested.

command_serviceRole :: Lens' Command (Maybe Text) Source #

The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.

command_status :: Lens' Command (Maybe CommandStatus) Source #

The status of the command.

command_statusDetails :: Lens' Command (Maybe Text) Source #

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

Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
Success: The command successfully ran on all invocations. This is a terminal state.
Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Cancelled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.

command_targetCount :: Lens' Command (Maybe Int) Source #

The number of targets for the command.

command_targets :: Lens' Command (Maybe [Target]) Source #

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

command_timeoutSeconds :: Lens' Command (Maybe Natural) Source #

The TimeoutSeconds value specified for a command.

command_triggeredAlarms :: Lens' Command (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarm that was invoked by the command.

CommandFilter

commandFilter_key :: Lens' CommandFilter CommandFilterKey Source #

The name of the filter.

The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.

commandFilter_value :: Lens' CommandFilter Text Source #

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

InvokedAfter: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions occurring July 7, 2021, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions from before July 7, 2021.
Status: Specify a valid command status to see a list of all command executions with that status. The status choices depend on the API you call.
The status values you can specify for ListCommands are:
- ```
Pending
```
- ```
InProgress
```
- ```
Success
```
- ```
Cancelled
```
- ```
Failed
```
- TimedOut (this includes both Delivery and Execution time outs)
- ```
AccessDenied
```
- ```
DeliveryTimedOut
```
- ```
ExecutionTimedOut
```
- ```
Incomplete
```
- ```
NoInstancesInTag
```
- ```
LimitExceeded
```
The status values you can specify for ListCommandInvocations are:
- ```
Pending
```
- ```
InProgress
```
- ```
Delayed
```
- ```
Success
```
- ```
Cancelled
```
- ```
Failed
```
- TimedOut (this includes both Delivery and Execution time outs)
- ```
AccessDenied
```
- ```
DeliveryTimedOut
```
- ```
ExecutionTimedOut
```
- ```
Undeliverable
```
- ```
InvalidPlatform
```
- ```
Terminated
```
DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on managed nodes.
ExecutionStage: Specify one of the following values (ListCommands operations only):
- Executing: Returns a list of command executions that are currently still running.
- Complete: Returns a list of command executions that have already completed.

CommandInvocation

commandInvocation_cloudWatchOutputConfig :: Lens' CommandInvocation (Maybe CloudWatchOutputConfig) Source #

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

commandInvocation_commandId :: Lens' CommandInvocation (Maybe Text) Source #

The command against which this invocation was requested.

commandInvocation_commandPlugins :: Lens' CommandInvocation (Maybe [CommandPlugin]) Source #

Plugins processed by the command.

commandInvocation_comment :: Lens' CommandInvocation (Maybe Text) Source #

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

commandInvocation_documentName :: Lens' CommandInvocation (Maybe Text) Source #

The document name that was requested for execution.

commandInvocation_documentVersion :: Lens' CommandInvocation (Maybe Text) Source #

The Systems Manager document (SSM document) version.

commandInvocation_instanceId :: Lens' CommandInvocation (Maybe Text) Source #

The managed node ID in which this invocation was requested.

commandInvocation_instanceName :: Lens' CommandInvocation (Maybe Text) Source #

The fully qualified host name of the managed node.

commandInvocation_notificationConfig :: Lens' CommandInvocation (Maybe NotificationConfig) Source #

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

commandInvocation_requestedDateTime :: Lens' CommandInvocation (Maybe UTCTime) Source #

The time and date the request was sent to this managed node.

commandInvocation_serviceRole :: Lens' CommandInvocation (Maybe Text) Source #

The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.

commandInvocation_standardErrorUrl :: Lens' CommandInvocation (Maybe Text) Source #

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

commandInvocation_standardOutputUrl :: Lens' CommandInvocation (Maybe Text) Source #

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

commandInvocation_status :: Lens' CommandInvocation (Maybe CommandInvocationStatus) Source #

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

commandInvocation_statusDetails :: Lens' CommandInvocation (Maybe Text) Source #

A detailed status of the command execution for each invocation (each managed node targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

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

commandInvocation_traceOutput :: Lens' CommandInvocation (Maybe Text) Source #

Gets the trace output sent by the agent.

CommandPlugin

commandPlugin_name :: Lens' CommandPlugin (Maybe Text) Source #

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

commandPlugin_output :: Lens' CommandPlugin (Maybe Text) Source #

Output of the plugin execution.

commandPlugin_outputS3BucketName :: Lens' CommandPlugin (Maybe Text) Source #

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

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

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

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

commandPlugin_outputS3KeyPrefix :: Lens' CommandPlugin (Maybe Text) Source #

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

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

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

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

commandPlugin_outputS3Region :: Lens' CommandPlugin (Maybe Text) Source #

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

commandPlugin_responseCode :: Lens' CommandPlugin (Maybe Int) Source #

A numeric response code generated after running the plugin.

commandPlugin_responseFinishDateTime :: Lens' CommandPlugin (Maybe UTCTime) Source #

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

commandPlugin_responseStartDateTime :: Lens' CommandPlugin (Maybe UTCTime) Source #

The time the plugin started running.

commandPlugin_standardErrorUrl :: Lens' CommandPlugin (Maybe Text) Source #

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

commandPlugin_standardOutputUrl :: Lens' CommandPlugin (Maybe Text) Source #

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

commandPlugin_status :: Lens' CommandPlugin (Maybe CommandPluginStatus) Source #

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

commandPlugin_statusDetails :: Lens' CommandPlugin (Maybe Text) Source #

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

Pending: The command hasn't been sent to the managed node.
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Cancelled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the managed node. The managed node might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

ComplianceExecutionSummary

complianceExecutionSummary_executionId :: Lens' ComplianceExecutionSummary (Maybe Text) Source #

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

complianceExecutionSummary_executionType :: Lens' ComplianceExecutionSummary (Maybe Text) Source #

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

complianceExecutionSummary_executionTime :: Lens' ComplianceExecutionSummary UTCTime Source #

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

ComplianceItem

complianceItem_complianceType :: Lens' ComplianceItem (Maybe Text) Source #

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

complianceItem_details :: Lens' ComplianceItem (Maybe (HashMap Text Text)) Source #

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

complianceItem_executionSummary :: Lens' ComplianceItem (Maybe ComplianceExecutionSummary) Source #

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

complianceItem_id :: Lens' ComplianceItem (Maybe Text) Source #

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

complianceItem_resourceId :: Lens' ComplianceItem (Maybe Text) Source #

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

complianceItem_resourceType :: Lens' ComplianceItem (Maybe Text) Source #

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

complianceItem_severity :: Lens' ComplianceItem (Maybe ComplianceSeverity) Source #

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

complianceItem_status :: Lens' ComplianceItem (Maybe ComplianceStatus) Source #

The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).

complianceItem_title :: Lens' ComplianceItem (Maybe Text) Source #

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

ComplianceItemEntry

complianceItemEntry_details :: Lens' ComplianceItemEntry (Maybe (HashMap Text Text)) Source #

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

complianceItemEntry_id :: Lens' ComplianceItemEntry (Maybe Text) Source #

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

complianceItemEntry_title :: Lens' ComplianceItemEntry (Maybe Text) Source #

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

complianceItemEntry_severity :: Lens' ComplianceItemEntry ComplianceSeverity Source #

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

complianceItemEntry_status :: Lens' ComplianceItemEntry ComplianceStatus Source #

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

ComplianceStringFilter

complianceStringFilter_key :: Lens' ComplianceStringFilter (Maybe Text) Source #

The name of the filter.

complianceStringFilter_type :: Lens' ComplianceStringFilter (Maybe ComplianceQueryOperatorType) Source #

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

complianceStringFilter_values :: Lens' ComplianceStringFilter (Maybe (NonEmpty Text)) Source #

The value for which to search.

ComplianceSummaryItem

complianceSummaryItem_complianceType :: Lens' ComplianceSummaryItem (Maybe Text) Source #

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

complianceSummaryItem_compliantSummary :: Lens' ComplianceSummaryItem (Maybe CompliantSummary) Source #

A list of COMPLIANT items for the specified compliance type.

complianceSummaryItem_nonCompliantSummary :: Lens' ComplianceSummaryItem (Maybe NonCompliantSummary) Source #

A list of NON_COMPLIANT items for the specified compliance type.

CompliantSummary

compliantSummary_compliantCount :: Lens' CompliantSummary (Maybe Int) Source #

The total number of resources that are compliant.

compliantSummary_severitySummary :: Lens' CompliantSummary (Maybe SeveritySummary) Source #

A summary of the compliance severity by compliance type.

CreateAssociationBatchRequestEntry

createAssociationBatchRequestEntry_alarmConfiguration :: Lens' CreateAssociationBatchRequestEntry (Maybe AlarmConfiguration) Source #

Undocumented member.

createAssociationBatchRequestEntry_applyOnlyAtCronInterval :: Lens' CreateAssociationBatchRequestEntry (Maybe Bool) Source #

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

createAssociationBatchRequestEntry_associationName :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #

Specify a descriptive name for the association.

createAssociationBatchRequestEntry_automationTargetParameterName :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #

Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

createAssociationBatchRequestEntry_calendarNames :: Lens' CreateAssociationBatchRequestEntry (Maybe [Text]) Source #

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

createAssociationBatchRequestEntry_complianceSeverity :: Lens' CreateAssociationBatchRequestEntry (Maybe AssociationComplianceSeverity) Source #

The severity level to assign to the association.

createAssociationBatchRequestEntry_documentVersion :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #

The document version.

createAssociationBatchRequestEntry_instanceId :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #

The managed node ID.

InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

createAssociationBatchRequestEntry_maxConcurrency :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #

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

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

createAssociationBatchRequestEntry_maxErrors :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #

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

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

createAssociationBatchRequestEntry_outputLocation :: Lens' CreateAssociationBatchRequestEntry (Maybe InstanceAssociationOutputLocation) Source #

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

createAssociationBatchRequestEntry_parameters :: Lens' CreateAssociationBatchRequestEntry (Maybe (HashMap Text [Text])) Source #

A description of the parameters for a document.

createAssociationBatchRequestEntry_scheduleExpression :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #

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

createAssociationBatchRequestEntry_scheduleOffset :: Lens' CreateAssociationBatchRequestEntry (Maybe Natural) Source #

Number of days to wait after the scheduled day to run an association.

createAssociationBatchRequestEntry_syncCompliance :: Lens' CreateAssociationBatchRequestEntry (Maybe AssociationSyncCompliance) Source #

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

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

createAssociationBatchRequestEntry_targetLocations :: Lens' CreateAssociationBatchRequestEntry (Maybe (NonEmpty TargetLocation)) Source #

Use this action to create an association in multiple Regions and multiple accounts.

createAssociationBatchRequestEntry_targetMaps :: Lens' CreateAssociationBatchRequestEntry (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

createAssociationBatchRequestEntry_targets :: Lens' CreateAssociationBatchRequestEntry (Maybe [Target]) Source #

The managed nodes targeted by the request.

createAssociationBatchRequestEntry_name :: Lens' CreateAssociationBatchRequestEntry Text Source #

The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.

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

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

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

For example:

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

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

DescribeActivationsFilter

describeActivationsFilter_filterKey :: Lens' DescribeActivationsFilter (Maybe DescribeActivationsFilterKeys) Source #

The name of the filter.

describeActivationsFilter_filterValues :: Lens' DescribeActivationsFilter (Maybe [Text]) Source #

The filter values.

DocumentDefaultVersionDescription

documentDefaultVersionDescription_defaultVersion :: Lens' DocumentDefaultVersionDescription (Maybe Text) Source #

The default version of the document.

documentDefaultVersionDescription_defaultVersionName :: Lens' DocumentDefaultVersionDescription (Maybe Text) Source #

The default version of the artifact associated with the document.

documentDefaultVersionDescription_name :: Lens' DocumentDefaultVersionDescription (Maybe Text) Source #

The name of the document.

DocumentDescription

documentDescription_approvedVersion :: Lens' DocumentDescription (Maybe Text) Source #

The version of the document currently approved for use in the organization.

documentDescription_attachmentsInformation :: Lens' DocumentDescription (Maybe [AttachmentInformation]) Source #

Details about the document attachments, including names, locations, sizes, and so on.

documentDescription_author :: Lens' DocumentDescription (Maybe Text) Source #

The user in your organization who created the document.

documentDescription_category :: Lens' DocumentDescription (Maybe [Text]) Source #

The classification of a document to help you identify and categorize its use.

documentDescription_categoryEnum :: Lens' DocumentDescription (Maybe [Text]) Source #

The value that identifies a document's category.

documentDescription_createdDate :: Lens' DocumentDescription (Maybe UTCTime) Source #

The date when the document was created.

documentDescription_defaultVersion :: Lens' DocumentDescription (Maybe Text) Source #

The default version.

documentDescription_description :: Lens' DocumentDescription (Maybe Text) Source #

A description of the document.

documentDescription_displayName :: Lens' DocumentDescription (Maybe Text) Source #

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

documentDescription_documentFormat :: Lens' DocumentDescription (Maybe DocumentFormat) Source #

The document format, either JSON or YAML.

documentDescription_documentType :: Lens' DocumentDescription (Maybe DocumentType) Source #

The type of document.

documentDescription_documentVersion :: Lens' DocumentDescription (Maybe Text) Source #

The document version.

documentDescription_hash :: Lens' DocumentDescription (Maybe Text) Source #

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

Sha1 hashes have been deprecated.

documentDescription_hashType :: Lens' DocumentDescription (Maybe DocumentHashType) Source #

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

Sha1 hashes have been deprecated.

documentDescription_latestVersion :: Lens' DocumentDescription (Maybe Text) Source #

The latest version of the document.

documentDescription_name :: Lens' DocumentDescription (Maybe Text) Source #

The name of the SSM document.

documentDescription_owner :: Lens' DocumentDescription (Maybe Text) Source #

The Amazon Web Services user account that created the document.

documentDescription_parameters :: Lens' DocumentDescription (Maybe [DocumentParameter]) Source #

A description of the parameters for a document.

documentDescription_pendingReviewVersion :: Lens' DocumentDescription (Maybe Text) Source #

The version of the document that is currently under review.

documentDescription_platformTypes :: Lens' DocumentDescription (Maybe [PlatformType]) Source #

The list of operating system (OS) platforms compatible with this SSM document.

documentDescription_requires :: Lens' DocumentDescription (Maybe (NonEmpty DocumentRequires)) Source #

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

documentDescription_reviewInformation :: Lens' DocumentDescription (Maybe (NonEmpty ReviewInformation)) Source #

Details about the review of a document.

documentDescription_reviewStatus :: Lens' DocumentDescription (Maybe ReviewStatus) Source #

The current status of the review.

documentDescription_schemaVersion :: Lens' DocumentDescription (Maybe Text) Source #

The schema version.

documentDescription_sha1 :: Lens' DocumentDescription (Maybe Text) Source #

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

documentDescription_status :: Lens' DocumentDescription (Maybe DocumentStatus) Source #

The status of the SSM document.

documentDescription_statusInformation :: Lens' DocumentDescription (Maybe Text) Source #

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

documentDescription_tags :: Lens' DocumentDescription (Maybe [Tag]) Source #

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

documentDescription_targetType :: Lens' DocumentDescription (Maybe Text) Source #

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

documentDescription_versionName :: Lens' DocumentDescription (Maybe Text) Source #

The version of the artifact associated with the document.

DocumentFilter

documentFilter_key :: Lens' DocumentFilter DocumentFilterKey Source #

The name of the filter.

documentFilter_value :: Lens' DocumentFilter Text Source #

The value of the filter.

DocumentIdentifier

documentIdentifier_author :: Lens' DocumentIdentifier (Maybe Text) Source #

The user in your organization who created the document.

documentIdentifier_createdDate :: Lens' DocumentIdentifier (Maybe UTCTime) Source #

The date the SSM document was created.

documentIdentifier_displayName :: Lens' DocumentIdentifier (Maybe Text) Source #

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

documentIdentifier_documentFormat :: Lens' DocumentIdentifier (Maybe DocumentFormat) Source #

The document format, either JSON or YAML.

documentIdentifier_documentType :: Lens' DocumentIdentifier (Maybe DocumentType) Source #

The document type.

documentIdentifier_documentVersion :: Lens' DocumentIdentifier (Maybe Text) Source #

The document version.

documentIdentifier_name :: Lens' DocumentIdentifier (Maybe Text) Source #

The name of the SSM document.

documentIdentifier_owner :: Lens' DocumentIdentifier (Maybe Text) Source #

The Amazon Web Services user account that created the document.

documentIdentifier_platformTypes :: Lens' DocumentIdentifier (Maybe [PlatformType]) Source #

The operating system platform.

documentIdentifier_requires :: Lens' DocumentIdentifier (Maybe (NonEmpty DocumentRequires)) Source #

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

documentIdentifier_reviewStatus :: Lens' DocumentIdentifier (Maybe ReviewStatus) Source #

The current status of a document review.

documentIdentifier_schemaVersion :: Lens' DocumentIdentifier (Maybe Text) Source #

The schema version.

documentIdentifier_tags :: Lens' DocumentIdentifier (Maybe [Tag]) Source #

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

documentIdentifier_targetType :: Lens' DocumentIdentifier (Maybe Text) Source #

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

documentIdentifier_versionName :: Lens' DocumentIdentifier (Maybe Text) Source #

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

DocumentKeyValuesFilter

documentKeyValuesFilter_key :: Lens' DocumentKeyValuesFilter (Maybe Text) Source #

The name of the filter key.

documentKeyValuesFilter_values :: Lens' DocumentKeyValuesFilter (Maybe [Text]) Source #

The value for the filter key.

DocumentMetadataResponseInfo

documentMetadataResponseInfo_reviewerResponse :: Lens' DocumentMetadataResponseInfo (Maybe [DocumentReviewerResponseSource]) Source #

Details about a reviewer's response to a document review request.

DocumentParameter

documentParameter_defaultValue :: Lens' DocumentParameter (Maybe Text) Source #

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

documentParameter_description :: Lens' DocumentParameter (Maybe Text) Source #

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

documentParameter_name :: Lens' DocumentParameter (Maybe Text) Source #

The name of the parameter.

documentParameter_type :: Lens' DocumentParameter (Maybe DocumentParameterType) Source #

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

DocumentRequires

documentRequires_requireType :: Lens' DocumentRequires (Maybe Text) Source #

The document type of the required SSM document.

documentRequires_version :: Lens' DocumentRequires (Maybe Text) Source #

The document version required by the current document.

documentRequires_versionName :: Lens' DocumentRequires (Maybe Text) Source #

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

documentRequires_name :: Lens' DocumentRequires Text Source #

The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

DocumentReviewCommentSource

documentReviewCommentSource_content :: Lens' DocumentReviewCommentSource (Maybe Text) Source #

The content of a comment entered by a user who requests a review of a new document version, or who reviews the new version.

documentReviewCommentSource_type :: Lens' DocumentReviewCommentSource (Maybe DocumentReviewCommentType) Source #

The type of information added to a review request. Currently, only the value Comment is supported.

DocumentReviewerResponseSource

documentReviewerResponseSource_comment :: Lens' DocumentReviewerResponseSource (Maybe [DocumentReviewCommentSource]) Source #

The comment entered by a reviewer as part of their document review response.

documentReviewerResponseSource_createTime :: Lens' DocumentReviewerResponseSource (Maybe UTCTime) Source #

The date and time that a reviewer entered a response to a document review request.

documentReviewerResponseSource_reviewStatus :: Lens' DocumentReviewerResponseSource (Maybe ReviewStatus) Source #

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

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

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

documentReviewerResponseSource_reviewer :: Lens' DocumentReviewerResponseSource (Maybe Text) Source #

The user in your organization assigned to review a document request.

documentReviewerResponseSource_updatedTime :: Lens' DocumentReviewerResponseSource (Maybe UTCTime) Source #

The date and time that a reviewer last updated a response to a document review request.

DocumentReviews

documentReviews_comment :: Lens' DocumentReviews (Maybe [DocumentReviewCommentSource]) Source #

A comment entered by a user in your organization about the document review request.

documentReviews_action :: Lens' DocumentReviews DocumentReviewAction Source #

The action to take on a document approval review request.

DocumentVersionInfo

documentVersionInfo_createdDate :: Lens' DocumentVersionInfo (Maybe UTCTime) Source #

The date the document was created.

documentVersionInfo_displayName :: Lens' DocumentVersionInfo (Maybe Text) Source #

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

documentVersionInfo_documentFormat :: Lens' DocumentVersionInfo (Maybe DocumentFormat) Source #

The document format, either JSON or YAML.

documentVersionInfo_documentVersion :: Lens' DocumentVersionInfo (Maybe Text) Source #

The document version.

documentVersionInfo_isDefaultVersion :: Lens' DocumentVersionInfo (Maybe Bool) Source #

An identifier for the default version of the document.

documentVersionInfo_name :: Lens' DocumentVersionInfo (Maybe Text) Source #

The document name.

documentVersionInfo_reviewStatus :: Lens' DocumentVersionInfo (Maybe ReviewStatus) Source #

The current status of the approval review for the latest version of the document.

documentVersionInfo_status :: Lens' DocumentVersionInfo (Maybe DocumentStatus) Source #

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

documentVersionInfo_statusInformation :: Lens' DocumentVersionInfo (Maybe Text) Source #

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

documentVersionInfo_versionName :: Lens' DocumentVersionInfo (Maybe Text) Source #

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

EffectivePatch

effectivePatch_patch :: Lens' EffectivePatch (Maybe Patch) Source #

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

effectivePatch_patchStatus :: Lens' EffectivePatch (Maybe PatchStatus) Source #

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

FailedCreateAssociation

failedCreateAssociation_entry :: Lens' FailedCreateAssociation (Maybe CreateAssociationBatchRequestEntry) Source #

The association.

failedCreateAssociation_fault :: Lens' FailedCreateAssociation (Maybe Fault) Source #

The source of the failure.

failedCreateAssociation_message :: Lens' FailedCreateAssociation (Maybe Text) Source #

A description of the failure.

FailureDetails

failureDetails_details :: Lens' FailureDetails (Maybe (HashMap Text [Text])) Source #

Detailed information about the Automation step failure.

failureDetails_failureStage :: Lens' FailureDetails (Maybe Text) Source #

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

failureDetails_failureType :: Lens' FailureDetails (Maybe Text) Source #

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

GetResourcePoliciesResponseEntry

getResourcePoliciesResponseEntry_policy :: Lens' GetResourcePoliciesResponseEntry (Maybe Text) Source #

A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

getResourcePoliciesResponseEntry_policyHash :: Lens' GetResourcePoliciesResponseEntry (Maybe Text) Source #

ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.

getResourcePoliciesResponseEntry_policyId :: Lens' GetResourcePoliciesResponseEntry (Maybe Text) Source #

A policy ID.

InstanceAggregatedAssociationOverview

instanceAggregatedAssociationOverview_detailedStatus :: Lens' InstanceAggregatedAssociationOverview (Maybe Text) Source #

Detailed status information about the aggregated associations.

instanceAggregatedAssociationOverview_instanceAssociationStatusAggregatedCount :: Lens' InstanceAggregatedAssociationOverview (Maybe (HashMap Text Int)) Source #

The number of associations for the managed node(s).

InstanceAssociation

instanceAssociation_associationId :: Lens' InstanceAssociation (Maybe Text) Source #

The association ID.

instanceAssociation_associationVersion :: Lens' InstanceAssociation (Maybe Text) Source #

Version information for the association on the managed node.

instanceAssociation_content :: Lens' InstanceAssociation (Maybe Text) Source #

The content of the association document for the managed node(s).

instanceAssociation_instanceId :: Lens' InstanceAssociation (Maybe Text) Source #

The managed node ID.

InstanceAssociationOutputLocation

instanceAssociationOutputLocation_s3Location :: Lens' InstanceAssociationOutputLocation (Maybe S3OutputLocation) Source #

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

InstanceAssociationOutputUrl

instanceAssociationOutputUrl_s3OutputUrl :: Lens' InstanceAssociationOutputUrl (Maybe S3OutputUrl) Source #

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

InstanceAssociationStatusInfo

instanceAssociationStatusInfo_associationId :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

The association ID.

instanceAssociationStatusInfo_associationName :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

The name of the association applied to the managed node.

instanceAssociationStatusInfo_associationVersion :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

The version of the association applied to the managed node.

instanceAssociationStatusInfo_detailedStatus :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

Detailed status information about the association.

instanceAssociationStatusInfo_documentVersion :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

The association document versions.

instanceAssociationStatusInfo_errorCode :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

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

instanceAssociationStatusInfo_executionDate :: Lens' InstanceAssociationStatusInfo (Maybe UTCTime) Source #

The date the association ran.

instanceAssociationStatusInfo_executionSummary :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

Summary information about association execution.

instanceAssociationStatusInfo_instanceId :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

The managed node ID where the association was created.

instanceAssociationStatusInfo_name :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

The name of the association.

instanceAssociationStatusInfo_outputUrl :: Lens' InstanceAssociationStatusInfo (Maybe InstanceAssociationOutputUrl) Source #

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

instanceAssociationStatusInfo_status :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #

Status information about the association.

InstanceInformation

instanceInformation_activationId :: Lens' InstanceInformation (Maybe Text) Source #

The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.

instanceInformation_agentVersion :: Lens' InstanceInformation (Maybe Text) Source #

The version of SSM Agent running on your Linux managed node.

instanceInformation_associationOverview :: Lens' InstanceInformation (Maybe InstanceAggregatedAssociationOverview) Source #

Information about the association.

instanceInformation_associationStatus :: Lens' InstanceInformation (Maybe Text) Source #

The status of the association.

instanceInformation_computerName :: Lens' InstanceInformation (Maybe Text) Source #

The fully qualified host name of the managed node.

instanceInformation_iPAddress :: Lens' InstanceInformation (Maybe Text) Source #

The IP address of the managed node.

instanceInformation_iamRole :: Lens' InstanceInformation (Maybe Text) Source #

The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

instanceInformation_instanceId :: Lens' InstanceInformation (Maybe Text) Source #

The managed node ID.

instanceInformation_isLatestVersion :: Lens' InstanceInformation (Maybe Bool) Source #

Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.

instanceInformation_lastAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime) Source #

The date the association was last run.

instanceInformation_lastPingDateTime :: Lens' InstanceInformation (Maybe UTCTime) Source #

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

instanceInformation_lastSuccessfulAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime) Source #

The last date the association was successfully run.

instanceInformation_name :: Lens' InstanceInformation (Maybe Text) Source #

The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

instanceInformation_pingStatus :: Lens' InstanceInformation (Maybe PingStatus) Source #

Connection status of SSM Agent.

The status Inactive has been deprecated and is no longer in use.

instanceInformation_platformName :: Lens' InstanceInformation (Maybe Text) Source #

The name of the operating system platform running on your managed node.

instanceInformation_platformType :: Lens' InstanceInformation (Maybe PlatformType) Source #

The operating system platform type.

instanceInformation_platformVersion :: Lens' InstanceInformation (Maybe Text) Source #

The version of the OS platform running on your managed node.

instanceInformation_registrationDate :: Lens' InstanceInformation (Maybe UTCTime) Source #

The date the server or VM was registered with Amazon Web Services as a managed node.

instanceInformation_resourceType :: Lens' InstanceInformation (Maybe ResourceType) Source #

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

instanceInformation_sourceId :: Lens' InstanceInformation (Maybe Text) Source #

The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.

instanceInformation_sourceType :: Lens' InstanceInformation (Maybe SourceType) Source #

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.

InstanceInformationFilter

instanceInformationFilter_key :: Lens' InstanceInformationFilter InstanceInformationFilterKey Source #

The name of the filter.

instanceInformationFilter_valueSet :: Lens' InstanceInformationFilter (NonEmpty Text) Source #

The filter values.

InstanceInformationStringFilter

instanceInformationStringFilter_key :: Lens' InstanceInformationStringFilter Text Source #

The filter key name to describe your managed nodes.

Valid filter key values: ActivationIds | AgentVersion | AssociationStatus | IamRole | InstanceIds | PingStatus | PlatformTypes | ResourceType | SourceIds | SourceTypes | "tag-key" | "tag:{keyname}

Valid values for the AssociationStatus filter key: Success | Pending | Failed
Valid values for the PingStatus filter key: Online | ConnectionLost | Inactive (deprecated)
Valid values for the PlatformType filter key: Windows | Linux | MacOS
Valid values for the ResourceType filter key: EC2Instance | ManagedInstance
Valid values for the SourceType filter key: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing
Valid tag examples: Key=tag-key,Values=Purpose | Key=tag:Purpose,Values=Test.

instanceInformationStringFilter_values :: Lens' InstanceInformationStringFilter (NonEmpty Text) Source #

The filter values.

InstancePatchState

instancePatchState_criticalNonCompliantCount :: Lens' InstancePatchState (Maybe Int) Source #

The number of patches per node that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

instancePatchState_failedCount :: Lens' InstancePatchState (Maybe Int) Source #

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

instancePatchState_installOverrideList :: Lens' InstancePatchState (Maybe Text) Source #

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

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

instancePatchState_installedCount :: Lens' InstancePatchState (Maybe Int) Source #

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

instancePatchState_installedOtherCount :: Lens' InstancePatchState (Maybe Int) Source #

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

instancePatchState_installedPendingRebootCount :: Lens' InstancePatchState (Maybe Int) Source #

The number of patches installed by Patch Manager since the last time the managed node was rebooted.

instancePatchState_installedRejectedCount :: Lens' InstancePatchState (Maybe Int) Source #

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

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

instancePatchState_lastNoRebootInstallOperationTime :: Lens' InstancePatchState (Maybe UTCTime) Source #

The time of the last attempt to patch the managed node with NoReboot specified as the reboot option.

instancePatchState_missingCount :: Lens' InstancePatchState (Maybe Int) Source #

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

instancePatchState_notApplicableCount :: Lens' InstancePatchState (Maybe Int) Source #

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

instancePatchState_otherNonCompliantCount :: Lens' InstancePatchState (Maybe Int) Source #

The number of patches per node that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT.

instancePatchState_ownerInformation :: Lens' InstancePatchState (Maybe Text) Source #

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

instancePatchState_rebootOption :: Lens' InstancePatchState (Maybe RebootOption) Source #

Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

RebootIfNeeded: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.
NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.

instancePatchState_securityNonCompliantCount :: Lens' InstancePatchState (Maybe Int) Source #

The number of patches per node that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

instancePatchState_snapshotId :: Lens' InstancePatchState (Maybe Text) Source #

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

instancePatchState_unreportedNotApplicableCount :: Lens' InstancePatchState (Maybe Int) Source #

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

instancePatchState_instanceId :: Lens' InstancePatchState Text Source #

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

instancePatchState_patchGroup :: Lens' InstancePatchState Text Source #

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

instancePatchState_baselineId :: Lens' InstancePatchState Text Source #

The ID of the patch baseline used to patch the managed node.

instancePatchState_operationStartTime :: Lens' InstancePatchState UTCTime Source #

The time the most recent patching operation was started on the managed node.

instancePatchState_operationEndTime :: Lens' InstancePatchState UTCTime Source #

The time the most recent patching operation completed on the managed node.

instancePatchState_operation :: Lens' InstancePatchState PatchOperationType Source #

The type of patching operation that was performed: or

SCAN assesses the patch compliance state.
INSTALL installs missing patches.

InstancePatchStateFilter

instancePatchStateFilter_key :: Lens' InstancePatchStateFilter Text Source #

The key for the filter. Supported values include the following:

```
InstalledCount
```
```
InstalledOtherCount
```
```
InstalledPendingRebootCount
```
```
InstalledRejectedCount
```
```
MissingCount
```
```
FailedCount
```
```
UnreportedNotApplicableCount
```
```
NotApplicableCount
```

instancePatchStateFilter_values :: Lens' InstancePatchStateFilter (NonEmpty Text) Source #

The value for the filter. Must be an integer greater than or equal to 0.

instancePatchStateFilter_type :: Lens' InstancePatchStateFilter InstancePatchStateOperatorType Source #

The type of comparison that should be performed for the value.

InventoryAggregator

inventoryAggregator_aggregators :: Lens' InventoryAggregator (Maybe (NonEmpty InventoryAggregator)) Source #

Nested aggregators to further refine aggregation for an inventory type.

inventoryAggregator_expression :: Lens' InventoryAggregator (Maybe Text) Source #

The inventory type and attribute name for aggregation.

inventoryAggregator_groups :: Lens' InventoryAggregator (Maybe (NonEmpty InventoryGroup)) Source #

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

InventoryDeletionStatusItem

inventoryDeletionStatusItem_deletionId :: Lens' InventoryDeletionStatusItem (Maybe Text) Source #

The deletion ID returned by the DeleteInventory operation.

inventoryDeletionStatusItem_deletionStartTime :: Lens' InventoryDeletionStatusItem (Maybe UTCTime) Source #

The UTC timestamp when the delete operation started.

inventoryDeletionStatusItem_deletionSummary :: Lens' InventoryDeletionStatusItem (Maybe InventoryDeletionSummary) Source #

Information about the delete operation. For more information about this summary, see Understanding the delete inventory summary in the Amazon Web Services Systems Manager User Guide.

inventoryDeletionStatusItem_lastStatus :: Lens' InventoryDeletionStatusItem (Maybe InventoryDeletionStatus) Source #

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

inventoryDeletionStatusItem_lastStatusMessage :: Lens' InventoryDeletionStatusItem (Maybe Text) Source #

Information about the status.

inventoryDeletionStatusItem_lastStatusUpdateTime :: Lens' InventoryDeletionStatusItem (Maybe UTCTime) Source #

The UTC timestamp of when the last status report.

inventoryDeletionStatusItem_typeName :: Lens' InventoryDeletionStatusItem (Maybe Text) Source #

The name of the inventory data type.

InventoryDeletionSummary

inventoryDeletionSummary_remainingCount :: Lens' InventoryDeletionSummary (Maybe Int) Source #

Remaining number of items to delete.

inventoryDeletionSummary_summaryItems :: Lens' InventoryDeletionSummary (Maybe [InventoryDeletionSummaryItem]) Source #

A list of counts and versions for deleted items.

inventoryDeletionSummary_totalCount :: Lens' InventoryDeletionSummary (Maybe Int) Source #

The total number of items to delete. This count doesn't change during the delete operation.

InventoryDeletionSummaryItem

inventoryDeletionSummaryItem_count :: Lens' InventoryDeletionSummaryItem (Maybe Int) Source #

A count of the number of deleted items.

inventoryDeletionSummaryItem_remainingCount :: Lens' InventoryDeletionSummaryItem (Maybe Int) Source #

The remaining number of items to delete.

inventoryDeletionSummaryItem_version :: Lens' InventoryDeletionSummaryItem (Maybe Text) Source #

The inventory type version.

InventoryFilter

inventoryFilter_type :: Lens' InventoryFilter (Maybe InventoryQueryOperatorType) Source #

The type of filter.

The Exists filter must be used with aggregators. For more information, see Aggregating inventory data in the Amazon Web Services Systems Manager User Guide.

inventoryFilter_key :: Lens' InventoryFilter Text Source #

The name of the filter key.

inventoryFilter_values :: Lens' InventoryFilter (NonEmpty Text) Source #

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

InventoryGroup

inventoryGroup_name :: Lens' InventoryGroup Text Source #

The name of the group.

inventoryGroup_filters :: Lens' InventoryGroup (NonEmpty InventoryFilter) Source #

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

InventoryItem

inventoryItem_content :: Lens' InventoryItem (Maybe [HashMap Text Text]) Source #

The inventory data of the inventory type.

inventoryItem_contentHash :: Lens' InventoryItem (Maybe Text) Source #

MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update.

inventoryItem_context :: Lens' InventoryItem (Maybe (HashMap Text Text)) Source #

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

inventoryItem_typeName :: Lens' InventoryItem Text Source #

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

inventoryItem_schemaVersion :: Lens' InventoryItem Text Source #

The schema version for the inventory item.

inventoryItem_captureTime :: Lens' InventoryItem Text Source #

The time the inventory information was collected.

InventoryItemAttribute

inventoryItemAttribute_name :: Lens' InventoryItemAttribute Text Source #

Name of the inventory item attribute.

inventoryItemAttribute_dataType :: Lens' InventoryItemAttribute InventoryAttributeDataType Source #

The data type of the inventory item attribute.

InventoryItemSchema

inventoryItemSchema_displayName :: Lens' InventoryItemSchema (Maybe Text) Source #

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

inventoryItemSchema_version :: Lens' InventoryItemSchema (Maybe Text) Source #

The schema version for the inventory item.

inventoryItemSchema_typeName :: Lens' InventoryItemSchema Text Source #

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

inventoryItemSchema_attributes :: Lens' InventoryItemSchema (NonEmpty InventoryItemAttribute) Source #

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

InventoryResultEntity

inventoryResultEntity_data :: Lens' InventoryResultEntity (Maybe (HashMap Text InventoryResultItem)) Source #

The data section in the inventory result entity JSON.

inventoryResultEntity_id :: Lens' InventoryResultEntity (Maybe Text) Source #

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

InventoryResultItem

inventoryResultItem_captureTime :: Lens' InventoryResultItem (Maybe Text) Source #

The time inventory item data was captured.

inventoryResultItem_contentHash :: Lens' InventoryResultItem (Maybe Text) Source #

MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update.

inventoryResultItem_typeName :: Lens' InventoryResultItem Text Source #

The name of the inventory result item type.

inventoryResultItem_schemaVersion :: Lens' InventoryResultItem Text Source #

The schema version for the inventory result item/

inventoryResultItem_content :: Lens' InventoryResultItem [HashMap Text Text] Source #

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

LoggingInfo

loggingInfo_s3KeyPrefix :: Lens' LoggingInfo (Maybe Text) Source #

(Optional) The S3 bucket subfolder.

loggingInfo_s3BucketName :: Lens' LoggingInfo Text Source #

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

loggingInfo_s3Region :: Lens' LoggingInfo Text Source #

The Amazon Web Services Region where the S3 bucket is located.

MaintenanceWindowAutomationParameters

maintenanceWindowAutomationParameters_documentVersion :: Lens' MaintenanceWindowAutomationParameters (Maybe Text) Source #

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

maintenanceWindowAutomationParameters_parameters :: Lens' MaintenanceWindowAutomationParameters (Maybe (HashMap Text [Text])) Source #

The parameters for the AUTOMATION task.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

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

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

For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified for these parameters.

MaintenanceWindowExecution

maintenanceWindowExecution_endTime :: Lens' MaintenanceWindowExecution (Maybe UTCTime) Source #

The time the execution finished.

maintenanceWindowExecution_startTime :: Lens' MaintenanceWindowExecution (Maybe UTCTime) Source #

The time the execution started.

maintenanceWindowExecution_status :: Lens' MaintenanceWindowExecution (Maybe MaintenanceWindowExecutionStatus) Source #

The status of the execution.

maintenanceWindowExecution_statusDetails :: Lens' MaintenanceWindowExecution (Maybe Text) Source #

The details explaining the status. Not available for all status values.

maintenanceWindowExecution_windowExecutionId :: Lens' MaintenanceWindowExecution (Maybe Text) Source #

The ID of the maintenance window execution.

maintenanceWindowExecution_windowId :: Lens' MaintenanceWindowExecution (Maybe Text) Source #

The ID of the maintenance window.

MaintenanceWindowExecutionTaskIdentity

maintenanceWindowExecutionTaskIdentity_alarmConfiguration :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe AlarmConfiguration) Source #

The details for the CloudWatch alarm applied to your maintenance window task.

maintenanceWindowExecutionTaskIdentity_endTime :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe UTCTime) Source #

The time the task execution finished.

maintenanceWindowExecutionTaskIdentity_startTime :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe UTCTime) Source #

The time the task execution started.

maintenanceWindowExecutionTaskIdentity_status :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe MaintenanceWindowExecutionStatus) Source #

The status of the task execution.

maintenanceWindowExecutionTaskIdentity_statusDetails :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text) Source #

The details explaining the status of the task execution. Not available for all status values.

maintenanceWindowExecutionTaskIdentity_taskArn :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task that ran.

maintenanceWindowExecutionTaskIdentity_taskExecutionId :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text) Source #

The ID of the specific task execution in the maintenance window execution.

maintenanceWindowExecutionTaskIdentity_taskType :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe MaintenanceWindowTaskType) Source #

The type of task that ran.

maintenanceWindowExecutionTaskIdentity_triggeredAlarms :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarm that was invoked by the maintenance window task.

maintenanceWindowExecutionTaskIdentity_windowExecutionId :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text) Source #

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

MaintenanceWindowExecutionTaskInvocationIdentity

maintenanceWindowExecutionTaskInvocationIdentity_endTime :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe UTCTime) Source #

The time the invocation finished.

maintenanceWindowExecutionTaskInvocationIdentity_executionId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #

The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.

maintenanceWindowExecutionTaskInvocationIdentity_invocationId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #

The ID of the task invocation.

maintenanceWindowExecutionTaskInvocationIdentity_ownerInformation :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #

User-provided value that was specified when the target was registered with the maintenance window. This was also included in any Amazon CloudWatch Events events raised during the task invocation.

maintenanceWindowExecutionTaskInvocationIdentity_parameters :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #

The parameters that were provided for the invocation when it was run.

maintenanceWindowExecutionTaskInvocationIdentity_startTime :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe UTCTime) Source #

The time the invocation started.

maintenanceWindowExecutionTaskInvocationIdentity_status :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe MaintenanceWindowExecutionStatus) Source #

The status of the task invocation.

maintenanceWindowExecutionTaskInvocationIdentity_statusDetails :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #

The details explaining the status of the task invocation. Not available for all status values.

maintenanceWindowExecutionTaskInvocationIdentity_taskExecutionId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #

The ID of the specific task execution in the maintenance window execution.

maintenanceWindowExecutionTaskInvocationIdentity_taskType :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe MaintenanceWindowTaskType) Source #

The task type.

maintenanceWindowExecutionTaskInvocationIdentity_windowExecutionId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #

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

maintenanceWindowExecutionTaskInvocationIdentity_windowTargetId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #

The ID of the target definition in this maintenance window the invocation was performed for.

MaintenanceWindowFilter

maintenanceWindowFilter_key :: Lens' MaintenanceWindowFilter (Maybe Text) Source #

The name of the filter.

maintenanceWindowFilter_values :: Lens' MaintenanceWindowFilter (Maybe [Text]) Source #

The filter values.

MaintenanceWindowIdentity

maintenanceWindowIdentity_cutoff :: Lens' MaintenanceWindowIdentity (Maybe Natural) Source #

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

maintenanceWindowIdentity_description :: Lens' MaintenanceWindowIdentity (Maybe Text) Source #

A description of the maintenance window.

maintenanceWindowIdentity_duration :: Lens' MaintenanceWindowIdentity (Maybe Natural) Source #

The duration of the maintenance window in hours.

maintenanceWindowIdentity_enabled :: Lens' MaintenanceWindowIdentity (Maybe Bool) Source #

Indicates whether the maintenance window is enabled.

maintenanceWindowIdentity_endDate :: Lens' MaintenanceWindowIdentity (Maybe Text) Source #

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

maintenanceWindowIdentity_name :: Lens' MaintenanceWindowIdentity (Maybe Text) Source #

The name of the maintenance window.

maintenanceWindowIdentity_nextExecutionTime :: Lens' MaintenanceWindowIdentity (Maybe Text) Source #

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

maintenanceWindowIdentity_schedule :: Lens' MaintenanceWindowIdentity (Maybe Text) Source #

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

maintenanceWindowIdentity_scheduleOffset :: Lens' MaintenanceWindowIdentity (Maybe Natural) Source #

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

maintenanceWindowIdentity_scheduleTimezone :: Lens' MaintenanceWindowIdentity (Maybe Text) Source #

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

maintenanceWindowIdentity_startDate :: Lens' MaintenanceWindowIdentity (Maybe Text) Source #

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

maintenanceWindowIdentity_windowId :: Lens' MaintenanceWindowIdentity (Maybe Text) Source #

The ID of the maintenance window.

MaintenanceWindowIdentityForTarget

maintenanceWindowIdentityForTarget_name :: Lens' MaintenanceWindowIdentityForTarget (Maybe Text) Source #

The name of the maintenance window.

maintenanceWindowIdentityForTarget_windowId :: Lens' MaintenanceWindowIdentityForTarget (Maybe Text) Source #

The ID of the maintenance window.

MaintenanceWindowLambdaParameters

maintenanceWindowLambdaParameters_clientContext :: Lens' MaintenanceWindowLambdaParameters (Maybe Text) Source #

Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.

maintenanceWindowLambdaParameters_payload :: Lens' MaintenanceWindowLambdaParameters (Maybe ByteString) Source #

JSON to provide to your Lambda function as input.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

maintenanceWindowLambdaParameters_qualifier :: Lens' MaintenanceWindowLambdaParameters (Maybe Text) Source #

(Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.

MaintenanceWindowRunCommandParameters

maintenanceWindowRunCommandParameters_cloudWatchOutputConfig :: Lens' MaintenanceWindowRunCommandParameters (Maybe CloudWatchOutputConfig) Source #

Undocumented member.

maintenanceWindowRunCommandParameters_comment :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

Information about the commands to run.

maintenanceWindowRunCommandParameters_documentHash :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

maintenanceWindowRunCommandParameters_documentHashType :: Lens' MaintenanceWindowRunCommandParameters (Maybe DocumentHashType) Source #

SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

maintenanceWindowRunCommandParameters_documentVersion :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

maintenanceWindowRunCommandParameters_notificationConfig :: Lens' MaintenanceWindowRunCommandParameters (Maybe NotificationConfig) Source #

Configurations for sending notifications about command status changes on a per-managed node basis.

maintenanceWindowRunCommandParameters_outputS3BucketName :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

The name of the Amazon Simple Storage Service (Amazon S3) bucket.

maintenanceWindowRunCommandParameters_outputS3KeyPrefix :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

The S3 bucket subfolder.

maintenanceWindowRunCommandParameters_parameters :: Lens' MaintenanceWindowRunCommandParameters (Maybe (HashMap Text [Text])) Source #

The parameters for the RUN_COMMAND task execution.

maintenanceWindowRunCommandParameters_serviceRoleArn :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

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

maintenanceWindowRunCommandParameters_timeoutSeconds :: Lens' MaintenanceWindowRunCommandParameters (Maybe Natural) Source #

If this time is reached and the command hasn't already started running, it doesn't run.

MaintenanceWindowStepFunctionsParameters

maintenanceWindowStepFunctionsParameters_input :: Lens' MaintenanceWindowStepFunctionsParameters (Maybe Text) Source #

The inputs for the STEP_FUNCTIONS task.

maintenanceWindowStepFunctionsParameters_name :: Lens' MaintenanceWindowStepFunctionsParameters (Maybe Text) Source #

The name of the STEP_FUNCTIONS task.

MaintenanceWindowTarget

maintenanceWindowTarget_description :: Lens' MaintenanceWindowTarget (Maybe Text) Source #

A description for the target.

maintenanceWindowTarget_name :: Lens' MaintenanceWindowTarget (Maybe Text) Source #

The name for the maintenance window target.

maintenanceWindowTarget_ownerInformation :: Lens' MaintenanceWindowTarget (Maybe Text) Source #

A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.

maintenanceWindowTarget_resourceType :: Lens' MaintenanceWindowTarget (Maybe MaintenanceWindowResourceType) Source #

The type of target that is being registered with the maintenance window.

maintenanceWindowTarget_targets :: Lens' MaintenanceWindowTarget (Maybe [Target]) Source #

The targets, either managed nodes or tags.

Specify managed nodes using the following format:

Key=instanceids,Values=<instanceid1>,<instanceid2>

Tags are specified using the following format:

Key=<tag name>,Values=<tag value>.

maintenanceWindowTarget_windowId :: Lens' MaintenanceWindowTarget (Maybe Text) Source #

The ID of the maintenance window to register the target with.

maintenanceWindowTarget_windowTargetId :: Lens' MaintenanceWindowTarget (Maybe Text) Source #

The ID of the target.

MaintenanceWindowTask

maintenanceWindowTask_alarmConfiguration :: Lens' MaintenanceWindowTask (Maybe AlarmConfiguration) Source #

The details for the CloudWatch alarm applied to your maintenance window task.

maintenanceWindowTask_cutoffBehavior :: Lens' MaintenanceWindowTask (Maybe MaintenanceWindowTaskCutoffBehavior) Source #

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

maintenanceWindowTask_description :: Lens' MaintenanceWindowTask (Maybe Text) Source #

A description of the task.

maintenanceWindowTask_loggingInfo :: Lens' MaintenanceWindowTask (Maybe LoggingInfo) Source #

Information about an S3 bucket to write task-level logs to.

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

maintenanceWindowTask_maxConcurrency :: Lens' MaintenanceWindowTask (Maybe Text) Source #

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

maintenanceWindowTask_maxErrors :: Lens' MaintenanceWindowTask (Maybe Text) Source #

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

maintenanceWindowTask_name :: Lens' MaintenanceWindowTask (Maybe Text) Source #

The task name.

maintenanceWindowTask_priority :: Lens' MaintenanceWindowTask (Maybe Natural) Source #

The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

maintenanceWindowTask_serviceRoleArn :: Lens' MaintenanceWindowTask (Maybe Text) Source #

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

maintenanceWindowTask_targets :: Lens' MaintenanceWindowTask (Maybe [Target]) Source #

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

maintenanceWindowTask_taskArn :: Lens' MaintenanceWindowTask (Maybe Text) Source #

The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

maintenanceWindowTask_taskParameters :: Lens' MaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #

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

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

maintenanceWindowTask_type :: Lens' MaintenanceWindowTask (Maybe MaintenanceWindowTaskType) Source #

The type of task.

maintenanceWindowTask_windowId :: Lens' MaintenanceWindowTask (Maybe Text) Source #

The ID of the maintenance window where the task is registered.

maintenanceWindowTask_windowTaskId :: Lens' MaintenanceWindowTask (Maybe Text) Source #

The task ID.

MaintenanceWindowTaskInvocationParameters

maintenanceWindowTaskInvocationParameters_automation :: Lens' MaintenanceWindowTaskInvocationParameters (Maybe MaintenanceWindowAutomationParameters) Source #

The parameters for an AUTOMATION task type.

maintenanceWindowTaskInvocationParameters_lambda :: Lens' MaintenanceWindowTaskInvocationParameters (Maybe MaintenanceWindowLambdaParameters) Source #

The parameters for a LAMBDA task type.

maintenanceWindowTaskInvocationParameters_runCommand :: Lens' MaintenanceWindowTaskInvocationParameters (Maybe MaintenanceWindowRunCommandParameters) Source #

The parameters for a RUN_COMMAND task type.

maintenanceWindowTaskInvocationParameters_stepFunctions :: Lens' MaintenanceWindowTaskInvocationParameters (Maybe MaintenanceWindowStepFunctionsParameters) Source #

The parameters for a STEP_FUNCTIONS task type.

MaintenanceWindowTaskParameterValueExpression

maintenanceWindowTaskParameterValueExpression_values :: Lens' MaintenanceWindowTaskParameterValueExpression (Maybe [Text]) Source #

This field contains an array of 0 or more strings, each 1 to 255 characters in length.

MetadataValue

metadataValue_value :: Lens' MetadataValue (Maybe Text) Source #

Metadata value to assign to an Application Manager application.

NonCompliantSummary

nonCompliantSummary_nonCompliantCount :: Lens' NonCompliantSummary (Maybe Int) Source #

The total number of compliance items that aren't compliant.

nonCompliantSummary_severitySummary :: Lens' NonCompliantSummary (Maybe SeveritySummary) Source #

A summary of the non-compliance severity by compliance type

NotificationConfig

notificationConfig_notificationArn :: Lens' NotificationConfig (Maybe Text) Source #

An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.

notificationConfig_notificationEvents :: Lens' NotificationConfig (Maybe [NotificationEvent]) Source #

The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

notificationConfig_notificationType :: Lens' NotificationConfig (Maybe NotificationType) Source #

The type of notification.

Command: Receive notification when the status of a command changes.
Invocation: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes.

OpsAggregator

opsAggregator_aggregatorType :: Lens' OpsAggregator (Maybe Text) Source #

Either a Range or Count aggregator for limiting an OpsData summary.

opsAggregator_aggregators :: Lens' OpsAggregator (Maybe (NonEmpty OpsAggregator)) Source #

A nested aggregator for viewing counts of OpsData.

opsAggregator_attributeName :: Lens' OpsAggregator (Maybe Text) Source #

The name of an OpsData attribute on which to limit the count of OpsData.

opsAggregator_filters :: Lens' OpsAggregator (Maybe (NonEmpty OpsFilter)) Source #

The aggregator filters.

opsAggregator_typeName :: Lens' OpsAggregator (Maybe Text) Source #

The data type name to use for viewing counts of OpsData.

opsAggregator_values :: Lens' OpsAggregator (Maybe (HashMap Text Text)) Source #

The aggregator value.

OpsEntity

opsEntity_data :: Lens' OpsEntity (Maybe (HashMap Text OpsEntityItem)) Source #

The data returned by the query.

opsEntity_id :: Lens' OpsEntity (Maybe Text) Source #

The query ID.

OpsEntityItem

opsEntityItem_captureTime :: Lens' OpsEntityItem (Maybe Text) Source #

The time the OpsData was captured.

opsEntityItem_content :: Lens' OpsEntityItem (Maybe [HashMap Text Text]) Source #

The details of an OpsData summary.

OpsFilter

opsFilter_type :: Lens' OpsFilter (Maybe OpsFilterOperatorType) Source #

The type of filter.

opsFilter_key :: Lens' OpsFilter Text Source #

The name of the filter.

opsFilter_values :: Lens' OpsFilter (NonEmpty Text) Source #

The filter value.

OpsItem

opsItem_actualEndTime :: Lens' OpsItem (Maybe UTCTime) Source #

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

opsItem_actualStartTime :: Lens' OpsItem (Maybe UTCTime) Source #

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

opsItem_category :: Lens' OpsItem (Maybe Text) Source #

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

opsItem_createdBy :: Lens' OpsItem (Maybe Text) Source #

The ARN of the Amazon Web Services account that created the OpsItem.

opsItem_createdTime :: Lens' OpsItem (Maybe UTCTime) Source #

The date and time the OpsItem was created.

opsItem_description :: Lens' OpsItem (Maybe Text) Source #

The OpsItem description.

opsItem_lastModifiedBy :: Lens' OpsItem (Maybe Text) Source #

The ARN of the Amazon Web Services account that last updated the OpsItem.

opsItem_lastModifiedTime :: Lens' OpsItem (Maybe UTCTime) Source #

The date and time the OpsItem was last updated.

opsItem_notifications :: Lens' OpsItem (Maybe [OpsItemNotification]) Source #

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

opsItem_operationalData :: Lens' OpsItem (Maybe (HashMap Text OpsItemDataValue)) Source #

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

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

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

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

opsItem_opsItemArn :: Lens' OpsItem (Maybe Text) Source #

The OpsItem Amazon Resource Name (ARN).

opsItem_opsItemId :: Lens' OpsItem (Maybe Text) Source #

The ID of the OpsItem.

opsItem_opsItemType :: Lens' OpsItem (Maybe Text) Source #

The type of OpsItem. Systems Manager supports the following types of OpsItems:

```
/aws/issue
```
This type of OpsItem is used for default OpsItems created by OpsCenter.
```
/aws/changerequest
```
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
```
/aws/insights
```
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

opsItem_plannedEndTime :: Lens' OpsItem (Maybe UTCTime) Source #

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

opsItem_plannedStartTime :: Lens' OpsItem (Maybe UTCTime) Source #

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

opsItem_priority :: Lens' OpsItem (Maybe Natural) Source #

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

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

opsItem_severity :: Lens' OpsItem (Maybe Text) Source #

The severity of the OpsItem. Severity options range from 1 to 4.

opsItem_source :: Lens' OpsItem (Maybe Text) Source #

The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.

opsItem_status :: Lens' OpsItem (Maybe OpsItemStatus) Source #

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

opsItem_title :: Lens' OpsItem (Maybe Text) Source #

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

opsItem_version :: Lens' OpsItem (Maybe Text) Source #

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

OpsItemDataValue

opsItemDataValue_type :: Lens' OpsItemDataValue (Maybe OpsItemDataType) Source #

The type of key-value pair. Valid types include SearchableString and String.

opsItemDataValue_value :: Lens' OpsItemDataValue (Maybe Text) Source #

The value of the OperationalData key.

OpsItemEventFilter

opsItemEventFilter_key :: Lens' OpsItemEventFilter OpsItemEventFilterKey Source #

The name of the filter key. Currently, the only supported value is OpsItemId.

opsItemEventFilter_values :: Lens' OpsItemEventFilter [Text] Source #

The values for the filter, consisting of one or more OpsItem IDs.

opsItemEventFilter_operator :: Lens' OpsItemEventFilter OpsItemEventFilterOperator Source #

The operator used by the filter call. Currently, the only supported value is Equal.

OpsItemEventSummary

opsItemEventSummary_createdBy :: Lens' OpsItemEventSummary (Maybe OpsItemIdentity) Source #

Information about the user or resource that created the OpsItem event.

opsItemEventSummary_createdTime :: Lens' OpsItemEventSummary (Maybe UTCTime) Source #

The date and time the OpsItem event was created.

opsItemEventSummary_detail :: Lens' OpsItemEventSummary (Maybe Text) Source #

Specific information about the OpsItem event.

opsItemEventSummary_detailType :: Lens' OpsItemEventSummary (Maybe Text) Source #

The type of information provided as a detail.

opsItemEventSummary_eventId :: Lens' OpsItemEventSummary (Maybe Text) Source #

The ID of the OpsItem event.

opsItemEventSummary_opsItemId :: Lens' OpsItemEventSummary (Maybe Text) Source #

The ID of the OpsItem.

opsItemEventSummary_source :: Lens' OpsItemEventSummary (Maybe Text) Source #

The source of the OpsItem event.

OpsItemFilter

opsItemFilter_key :: Lens' OpsItemFilter OpsItemFilterKey Source #

The name of the filter.

opsItemFilter_values :: Lens' OpsItemFilter [Text] Source #

The filter value.

opsItemFilter_operator :: Lens' OpsItemFilter OpsItemFilterOperator Source #

The operator used by the filter call.

OpsItemIdentity

opsItemIdentity_arn :: Lens' OpsItemIdentity (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.

OpsItemNotification

opsItemNotification_arn :: Lens' OpsItemNotification (Maybe Text) Source #

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

OpsItemRelatedItemSummary

The association ID.

The association type.

Undocumented member.

The time the related-item association was created.

Undocumented member.

The time the related-item association was last updated.

The OpsItem ID.

The resource type.

The Amazon Resource Name (ARN) of the related-item resource.

OpsItemRelatedItemsFilter

The name of the filter key. Supported values include ResourceUri, ResourceType, or AssociationId.

The values for the filter.

The operator used by the filter call. The only supported operator is EQUAL.

OpsItemSummary

opsItemSummary_actualEndTime :: Lens' OpsItemSummary (Maybe UTCTime) Source #

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

opsItemSummary_actualStartTime :: Lens' OpsItemSummary (Maybe UTCTime) Source #

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

opsItemSummary_category :: Lens' OpsItemSummary (Maybe Text) Source #

A list of OpsItems by category.

opsItemSummary_createdBy :: Lens' OpsItemSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

opsItemSummary_createdTime :: Lens' OpsItemSummary (Maybe UTCTime) Source #

The date and time the OpsItem was created.

opsItemSummary_lastModifiedBy :: Lens' OpsItemSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

opsItemSummary_lastModifiedTime :: Lens' OpsItemSummary (Maybe UTCTime) Source #

The date and time the OpsItem was last updated.

opsItemSummary_operationalData :: Lens' OpsItemSummary (Maybe (HashMap Text OpsItemDataValue)) Source #

Operational data is custom data that provides useful reference details about the OpsItem.

opsItemSummary_opsItemId :: Lens' OpsItemSummary (Maybe Text) Source #

The ID of the OpsItem.

opsItemSummary_opsItemType :: Lens' OpsItemSummary (Maybe Text) Source #

The type of OpsItem. Systems Manager supports the following types of OpsItems:

```
/aws/issue
```
This type of OpsItem is used for default OpsItems created by OpsCenter.
```
/aws/changerequest
```
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
```
/aws/insights
```
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

opsItemSummary_plannedEndTime :: Lens' OpsItemSummary (Maybe UTCTime) Source #

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

opsItemSummary_plannedStartTime :: Lens' OpsItemSummary (Maybe UTCTime) Source #

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

opsItemSummary_priority :: Lens' OpsItemSummary (Maybe Natural) Source #

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

opsItemSummary_severity :: Lens' OpsItemSummary (Maybe Text) Source #

A list of OpsItems by severity.

opsItemSummary_source :: Lens' OpsItemSummary (Maybe Text) Source #

The impacted Amazon Web Services resource.

opsItemSummary_status :: Lens' OpsItemSummary (Maybe OpsItemStatus) Source #

The OpsItem status. Status can be Open, In Progress, or Resolved.

opsItemSummary_title :: Lens' OpsItemSummary (Maybe Text) Source #

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

OpsMetadata

opsMetadata_creationDate :: Lens' OpsMetadata (Maybe UTCTime) Source #

The date the OpsMetadata objects was created.

opsMetadata_lastModifiedDate :: Lens' OpsMetadata (Maybe UTCTime) Source #

The date the OpsMetadata object was last updated.

opsMetadata_lastModifiedUser :: Lens' OpsMetadata (Maybe Text) Source #

The user name who last updated the OpsMetadata object.

opsMetadata_opsMetadataArn :: Lens' OpsMetadata (Maybe Text) Source #

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

opsMetadata_resourceId :: Lens' OpsMetadata (Maybe Text) Source #

The ID of the Application Manager application.

OpsMetadataFilter

opsMetadataFilter_key :: Lens' OpsMetadataFilter Text Source #

A filter key.

opsMetadataFilter_values :: Lens' OpsMetadataFilter (NonEmpty Text) Source #

A filter value.

OpsResultAttribute

opsResultAttribute_typeName :: Lens' OpsResultAttribute Text Source #

Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, AWS:OpsItemTrendline, or AWS:ComplianceSummary.

OutputSource

outputSource_outputSourceId :: Lens' OutputSource (Maybe Text) Source #

The ID of the output source, for example the URL of an S3 bucket.

outputSource_outputSourceType :: Lens' OutputSource (Maybe Text) Source #

The type of source where the association execution details are stored, for example, Amazon S3.

Parameter

parameter_arn :: Lens' Parameter (Maybe Text) Source #

The Amazon Resource Name (ARN) of the parameter.

parameter_dataType :: Lens' Parameter (Maybe Text) Source #

The data type of the parameter, such as text or aws:ec2:image. The default is text.

parameter_lastModifiedDate :: Lens' Parameter (Maybe UTCTime) Source #

Date the parameter was last changed or updated and the parameter version was created.

parameter_selector :: Lens' Parameter (Maybe Text) Source #

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

parameter_sourceResult :: Lens' Parameter (Maybe Text) Source #

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

parameter_name :: Lens' Parameter Text Source #

The name of the parameter.

parameter_type :: Lens' Parameter ParameterType Source #

The type of parameter. Valid values include the following: String, StringList, and SecureString.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

parameter_value :: Lens' Parameter Text Source #

The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

parameter_version :: Lens' Parameter Integer Source #

The parameter version.

ParameterHistory

parameterHistory_allowedPattern :: Lens' ParameterHistory (Maybe Text) Source #

Parameter names can include the following letters and symbols.

a-zA-Z0-9_.-

parameterHistory_dataType :: Lens' ParameterHistory (Maybe Text) Source #

The data type of the parameter, such as text or aws:ec2:image. The default is text.

parameterHistory_description :: Lens' ParameterHistory (Maybe Text) Source #

Information about the parameter.

parameterHistory_keyId :: Lens' ParameterHistory (Maybe Text) Source #

The ID of the query key used for this parameter.

parameterHistory_labels :: Lens' ParameterHistory (Maybe (NonEmpty Text)) Source #

Labels assigned to the parameter version.

parameterHistory_lastModifiedDate :: Lens' ParameterHistory (Maybe UTCTime) Source #

Date the parameter was last changed or updated.

parameterHistory_lastModifiedUser :: Lens' ParameterHistory (Maybe Text) Source #

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

parameterHistory_name :: Lens' ParameterHistory (Maybe Text) Source #

The name of the parameter.

parameterHistory_policies :: Lens' ParameterHistory (Maybe [ParameterInlinePolicy]) Source #

Information about the policies assigned to a parameter.

Assigning parameter policies in the Amazon Web Services Systems Manager User Guide.

parameterHistory_tier :: Lens' ParameterHistory (Maybe ParameterTier) Source #

The parameter tier.

parameterHistory_type :: Lens' ParameterHistory (Maybe ParameterType) Source #

The type of parameter used.

parameterHistory_value :: Lens' ParameterHistory (Maybe Text) Source #

The parameter value.

parameterHistory_version :: Lens' ParameterHistory (Maybe Integer) Source #

The parameter version.

ParameterInlinePolicy

parameterInlinePolicy_policyStatus :: Lens' ParameterInlinePolicy (Maybe Text) Source #

The status of the policy. Policies report the following statuses: Pending (the policy hasn't been enforced or applied yet), Finished (the policy was applied), Failed (the policy wasn't applied), or InProgress (the policy is being applied now).

parameterInlinePolicy_policyText :: Lens' ParameterInlinePolicy (Maybe Text) Source #

The JSON text of the policy.

parameterInlinePolicy_policyType :: Lens' ParameterInlinePolicy (Maybe Text) Source #

The type of policy. Parameter Store, a capability of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

ParameterMetadata

parameterMetadata_allowedPattern :: Lens' ParameterMetadata (Maybe Text) Source #

A parameter name can include only the following letters and symbols.

a-zA-Z0-9_.-

parameterMetadata_dataType :: Lens' ParameterMetadata (Maybe Text) Source #

The data type of the parameter, such as text or aws:ec2:image. The default is text.

parameterMetadata_description :: Lens' ParameterMetadata (Maybe Text) Source #

Description of the parameter actions.

parameterMetadata_keyId :: Lens' ParameterMetadata (Maybe Text) Source #

The ID of the query key used for this parameter.

parameterMetadata_lastModifiedDate :: Lens' ParameterMetadata (Maybe UTCTime) Source #

Date the parameter was last changed or updated.

parameterMetadata_lastModifiedUser :: Lens' ParameterMetadata (Maybe Text) Source #

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

parameterMetadata_name :: Lens' ParameterMetadata (Maybe Text) Source #

The parameter name.

parameterMetadata_policies :: Lens' ParameterMetadata (Maybe [ParameterInlinePolicy]) Source #

A list of policies associated with a parameter.

parameterMetadata_tier :: Lens' ParameterMetadata (Maybe ParameterTier) Source #

The parameter tier.

parameterMetadata_type :: Lens' ParameterMetadata (Maybe ParameterType) Source #

The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

parameterMetadata_version :: Lens' ParameterMetadata (Maybe Integer) Source #

The parameter version.

ParameterStringFilter

parameterStringFilter_option :: Lens' ParameterStringFilter (Maybe Text) Source #

For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using Label as the Key name, the only valid option is Equals.)

parameterStringFilter_values :: Lens' ParameterStringFilter (Maybe (NonEmpty Text)) Source #

The value you want to search for.

parameterStringFilter_key :: Lens' ParameterStringFilter Text Source #

The name of the filter.

The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for Key can be used with both operations.

For DescribeParameters, all of the listed patterns are valid except Label.

For GetParametersByPath, the following patterns listed for Key aren't valid: tag, DataType, Name, Path, and Tier.

For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

ParametersFilter

parametersFilter_key :: Lens' ParametersFilter ParametersFilterKey Source #

The name of the filter.

parametersFilter_values :: Lens' ParametersFilter (NonEmpty Text) Source #

The filter values.

Patch

patch_advisoryIds :: Lens' Patch (Maybe [Text]) Source #

The Advisory ID of the patch. For example, RHSA-2020:3779. Applies to Linux-based managed nodes only.

patch_arch :: Lens' Patch (Maybe Text) Source #

The architecture of the patch. For example, in example-pkg-0.710.10-2.7.abcd.x86_64, the architecture is indicated by x86_64. Applies to Linux-based managed nodes only.

patch_bugzillaIds :: Lens' Patch (Maybe [Text]) Source #

The Bugzilla ID of the patch. For example, 1600646. Applies to Linux-based managed nodes only.

patch_cVEIds :: Lens' Patch (Maybe [Text]) Source #

The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, CVE-2011-3192. Applies to Linux-based managed nodes only.

patch_classification :: Lens' Patch (Maybe Text) Source #

The classification of the patch. For example, SecurityUpdates, Updates, or CriticalUpdates.

patch_contentUrl :: Lens' Patch (Maybe Text) Source #

The URL where more information can be obtained about the patch.

patch_description :: Lens' Patch (Maybe Text) Source #

The description of the patch.

patch_epoch :: Lens' Patch (Maybe Int) Source #

The epoch of the patch. For example in pkg-example-EE-20180914-2.2.amzn1.noarch, the epoch value is 20180914-2. Applies to Linux-based managed nodes only.

patch_id :: Lens' Patch (Maybe Text) Source #

The ID of the patch. Applies to Windows patches only.

This ID isn't the same as the Microsoft Knowledge Base ID.

patch_kbNumber :: Lens' Patch (Maybe Text) Source #

The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.

patch_language :: Lens' Patch (Maybe Text) Source #

The language of the patch if it's language-specific.

patch_msrcNumber :: Lens' Patch (Maybe Text) Source #

The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to. For example, MS14-045. Applies to Windows patches only.

patch_msrcSeverity :: Lens' Patch (Maybe Text) Source #

The severity of the patch, such as Critical, Important, or Moderate. Applies to Windows patches only.

patch_name :: Lens' Patch (Maybe Text) Source #

The name of the patch. Applies to Linux-based managed nodes only.

patch_product :: Lens' Patch (Maybe Text) Source #

The specific product the patch is applicable for. For example, WindowsServer2016 or AmazonLinux2018.03.

patch_productFamily :: Lens' Patch (Maybe Text) Source #

The product family the patch is applicable for. For example, Windows or Amazon Linux 2.

patch_release :: Lens' Patch (Maybe Text) Source #

The particular release of a patch. For example, in pkg-example-EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1. Applies to Linux-based managed nodes only.

patch_releaseDate :: Lens' Patch (Maybe UTCTime) Source #

The date the patch was released.

patch_repository :: Lens' Patch (Maybe Text) Source #

The source patch repository for the operating system and version, such as trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu Server 20.04 LTE. Applies to Linux-based managed nodes only.

patch_severity :: Lens' Patch (Maybe Text) Source #

The severity level of the patch. For example, CRITICAL or MODERATE.

patch_title :: Lens' Patch (Maybe Text) Source #

The title of the patch.

patch_vendor :: Lens' Patch (Maybe Text) Source #

The name of the vendor providing the patch.

patch_version :: Lens' Patch (Maybe Text) Source #

The version number of the patch. For example, in example-pkg-1.710.10-2.7.abcd.x86_64, the version number is indicated by -1. Applies to Linux-based managed nodes only.

PatchBaselineIdentity

patchBaselineIdentity_baselineDescription :: Lens' PatchBaselineIdentity (Maybe Text) Source #

The description of the patch baseline.

patchBaselineIdentity_baselineId :: Lens' PatchBaselineIdentity (Maybe Text) Source #

The ID of the patch baseline.

patchBaselineIdentity_baselineName :: Lens' PatchBaselineIdentity (Maybe Text) Source #

The name of the patch baseline.

patchBaselineIdentity_defaultBaseline :: Lens' PatchBaselineIdentity (Maybe Bool) Source #

Whether this is the default baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

patchBaselineIdentity_operatingSystem :: Lens' PatchBaselineIdentity (Maybe OperatingSystem) Source #

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

PatchComplianceData

patchComplianceData_cVEIds :: Lens' PatchComplianceData (Maybe Text) Source #

The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.

patchComplianceData_title :: Lens' PatchComplianceData Text Source #

The title of the patch.

patchComplianceData_kBId :: Lens' PatchComplianceData Text Source #

The operating system-specific ID of the patch.

patchComplianceData_classification :: Lens' PatchComplianceData Text Source #

The classification of the patch, such as SecurityUpdates, Updates, and CriticalUpdates.

patchComplianceData_severity :: Lens' PatchComplianceData Text Source #

The severity of the patch such as Critical, Important, and Moderate.

patchComplianceData_state :: Lens' PatchComplianceData PatchComplianceDataState Source #

The state of the patch on the managed node, such as INSTALLED or FAILED.

For descriptions of each patch state, see About patch compliance in the Amazon Web Services Systems Manager User Guide.

patchComplianceData_installedTime :: Lens' PatchComplianceData UTCTime Source #

The date/time the patch was installed on the managed node. Not all operating systems provide this level of information.

PatchFilter

patchFilter_key :: Lens' PatchFilter PatchFilterKey Source #

The key for the filter.

Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

patchFilter_values :: Lens' PatchFilter (NonEmpty Text) Source #

The value for the filter key.

Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.

PatchFilterGroup

patchFilterGroup_patchFilters :: Lens' PatchFilterGroup [PatchFilter] Source #

The set of patch filters that make up the group.

PatchGroupPatchBaselineMapping

patchGroupPatchBaselineMapping_baselineIdentity :: Lens' PatchGroupPatchBaselineMapping (Maybe PatchBaselineIdentity) Source #

The patch baseline the patch group is registered with.

patchGroupPatchBaselineMapping_patchGroup :: Lens' PatchGroupPatchBaselineMapping (Maybe Text) Source #

The name of the patch group registered with the patch baseline.

PatchOrchestratorFilter

patchOrchestratorFilter_key :: Lens' PatchOrchestratorFilter (Maybe Text) Source #

The key for the filter.

patchOrchestratorFilter_values :: Lens' PatchOrchestratorFilter (Maybe [Text]) Source #

The value for the filter.

PatchRule

patchRule_approveAfterDays :: Lens' PatchRule (Maybe Natural) Source #

The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released. Not supported on Debian Server or Ubuntu Server.

patchRule_approveUntilDate :: Lens' PatchRule (Maybe Text) Source #

The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Not supported on Debian Server or Ubuntu Server.

Enter dates in the format YYYY-MM-DD. For example, 2021-12-31.

patchRule_complianceLevel :: Lens' PatchRule (Maybe PatchComplianceLevel) Source #

A compliance severity level for all approved patches in a patch baseline.

patchRule_enableNonSecurity :: Lens' PatchRule (Maybe Bool) Source #

For managed nodes identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is false. Applies to Linux managed nodes only.

patchRule_patchFilterGroup :: Lens' PatchRule PatchFilterGroup Source #

The patch filter group that defines the criteria for the rule.

PatchRuleGroup

patchRuleGroup_patchRules :: Lens' PatchRuleGroup [PatchRule] Source #

The rules that make up the rule group.

PatchSource

patchSource_name :: Lens' PatchSource Text Source #

The name specified to identify the patch source.

patchSource_products :: Lens' PatchSource (NonEmpty Text) Source #

The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter.

patchSource_configuration :: Lens' PatchSource Text Source #

The value of the yum repo configuration. For example:

[main]

name=MyCustomRepository

baseurl=https://my-custom-repository

enabled=1

For information about other options available for your yum repository configuration, see dnf.conf(5).

PatchStatus

patchStatus_approvalDate :: Lens' PatchStatus (Maybe UTCTime) Source #

The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).

patchStatus_complianceLevel :: Lens' PatchStatus (Maybe PatchComplianceLevel) Source #

The compliance severity level for a patch.

patchStatus_deploymentStatus :: Lens' PatchStatus (Maybe PatchDeploymentStatus) Source #

The approval status of a patch.

ProgressCounters

progressCounters_cancelledSteps :: Lens' ProgressCounters (Maybe Int) Source #

The total number of steps that the system cancelled in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

progressCounters_failedSteps :: Lens' ProgressCounters (Maybe Int) Source #

The total number of steps that failed to run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

progressCounters_successSteps :: Lens' ProgressCounters (Maybe Int) Source #

The total number of steps that successfully completed in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

progressCounters_timedOutSteps :: Lens' ProgressCounters (Maybe Int) Source #

The total number of steps that timed out in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

progressCounters_totalSteps :: Lens' ProgressCounters (Maybe Int) Source #

The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

RegistrationMetadataItem

registrationMetadataItem_key :: Lens' RegistrationMetadataItem Text Source #

Reserved for internal use.

registrationMetadataItem_value :: Lens' RegistrationMetadataItem Text Source #

Reserved for internal use.

The ID of an OpsItem related to the current OpsItem.

ResolvedTargets

resolvedTargets_parameterValues :: Lens' ResolvedTargets (Maybe [Text]) Source #

A list of parameter values sent to targets that resolved during the Automation execution.

resolvedTargets_truncated :: Lens' ResolvedTargets (Maybe Bool) Source #

A boolean value indicating whether the resolved target list is truncated.

ResourceComplianceSummaryItem

resourceComplianceSummaryItem_complianceType :: Lens' ResourceComplianceSummaryItem (Maybe Text) Source #

The compliance type.

resourceComplianceSummaryItem_compliantSummary :: Lens' ResourceComplianceSummaryItem (Maybe CompliantSummary) Source #

A list of items that are compliant for the resource.

resourceComplianceSummaryItem_executionSummary :: Lens' ResourceComplianceSummaryItem (Maybe ComplianceExecutionSummary) Source #

Information about the execution.

resourceComplianceSummaryItem_nonCompliantSummary :: Lens' ResourceComplianceSummaryItem (Maybe NonCompliantSummary) Source #

A list of items that aren't compliant for the resource.

resourceComplianceSummaryItem_overallSeverity :: Lens' ResourceComplianceSummaryItem (Maybe ComplianceSeverity) Source #

The highest severity item found for the resource. The resource is compliant for this item.

resourceComplianceSummaryItem_resourceId :: Lens' ResourceComplianceSummaryItem (Maybe Text) Source #

The resource ID.

resourceComplianceSummaryItem_resourceType :: Lens' ResourceComplianceSummaryItem (Maybe Text) Source #

The resource type.

resourceComplianceSummaryItem_status :: Lens' ResourceComplianceSummaryItem (Maybe ComplianceStatus) Source #

The compliance status for the resource.

ResourceDataSyncAwsOrganizationsSource

resourceDataSyncAwsOrganizationsSource_organizationalUnits :: Lens' ResourceDataSyncAwsOrganizationsSource (Maybe (NonEmpty ResourceDataSyncOrganizationalUnit)) Source #

The Organizations organization units included in the sync.

resourceDataSyncAwsOrganizationsSource_organizationSourceType :: Lens' ResourceDataSyncAwsOrganizationsSource Text Source #

If an Amazon Web Services organization is present, this is either OrganizationalUnits or EntireOrganization. For OrganizationalUnits, the data is aggregated from a set of organization units. For EntireOrganization, the data is aggregated from the entire Amazon Web Services organization.

ResourceDataSyncDestinationDataSharing

resourceDataSyncDestinationDataSharing_destinationDataSharingType :: Lens' ResourceDataSyncDestinationDataSharing (Maybe Text) Source #

The sharing data type. Only Organization is supported.

ResourceDataSyncItem

resourceDataSyncItem_lastStatus :: Lens' ResourceDataSyncItem (Maybe LastResourceDataSyncStatus) Source #

The status reported by the last sync.

resourceDataSyncItem_lastSuccessfulSyncTime :: Lens' ResourceDataSyncItem (Maybe UTCTime) Source #

The last time the sync operations returned a status of SUCCESSFUL (UTC).

resourceDataSyncItem_lastSyncStatusMessage :: Lens' ResourceDataSyncItem (Maybe Text) Source #

The status message details reported by the last sync.

resourceDataSyncItem_lastSyncTime :: Lens' ResourceDataSyncItem (Maybe UTCTime) Source #

The last time the configuration attempted to sync (UTC).

resourceDataSyncItem_s3Destination :: Lens' ResourceDataSyncItem (Maybe ResourceDataSyncS3Destination) Source #

Configuration information for the target S3 bucket.

resourceDataSyncItem_syncCreatedTime :: Lens' ResourceDataSyncItem (Maybe UTCTime) Source #

The date and time the configuration was created (UTC).

resourceDataSyncItem_syncLastModifiedTime :: Lens' ResourceDataSyncItem (Maybe UTCTime) Source #

The date and time the resource data sync was changed.

resourceDataSyncItem_syncName :: Lens' ResourceDataSyncItem (Maybe Text) Source #

The name of the resource data sync.

resourceDataSyncItem_syncSource :: Lens' ResourceDataSyncItem (Maybe ResourceDataSyncSourceWithState) Source #

Information about the source where the data was synchronized.

resourceDataSyncItem_syncType :: Lens' ResourceDataSyncItem (Maybe Text) Source #

The type of resource data sync. If SyncType is SyncToDestination, then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from Organizations or from multiple Amazon Web Services Regions.

ResourceDataSyncOrganizationalUnit

resourceDataSyncOrganizationalUnit_organizationalUnitId :: Lens' ResourceDataSyncOrganizationalUnit (Maybe Text) Source #

The Organizations unit ID data source for the sync.

ResourceDataSyncS3Destination

resourceDataSyncS3Destination_aWSKMSKeyARN :: Lens' ResourceDataSyncS3Destination (Maybe Text) Source #

The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.

resourceDataSyncS3Destination_destinationDataSharing :: Lens' ResourceDataSyncS3Destination (Maybe ResourceDataSyncDestinationDataSharing) Source #

Enables destination data sharing. By default, this field is null.

resourceDataSyncS3Destination_prefix :: Lens' ResourceDataSyncS3Destination (Maybe Text) Source #

An Amazon S3 prefix for the bucket.

resourceDataSyncS3Destination_bucketName :: Lens' ResourceDataSyncS3Destination Text Source #

The name of the S3 bucket where the aggregated data is stored.

resourceDataSyncS3Destination_syncFormat :: Lens' ResourceDataSyncS3Destination ResourceDataSyncS3Format Source #

A supported sync format. The following format is currently supported: JsonSerDe

resourceDataSyncS3Destination_region :: Lens' ResourceDataSyncS3Destination Text Source #

The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.

ResourceDataSyncSource

resourceDataSyncSource_awsOrganizationsSource :: Lens' ResourceDataSyncSource (Maybe ResourceDataSyncAwsOrganizationsSource) Source #

Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from Organizations.

resourceDataSyncSource_enableAllOpsDataSources :: Lens' ResourceDataSyncSource (Maybe Bool) Source #

When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.

resourceDataSyncSource_includeFutureRegions :: Lens' ResourceDataSyncSource (Maybe Bool) Source #

Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.

resourceDataSyncSource_sourceType :: Lens' ResourceDataSyncSource Text Source #

The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or SingleAccountMultiRegions.

resourceDataSyncSource_sourceRegions :: Lens' ResourceDataSyncSource [Text] Source #

The SyncSource Amazon Web Services Regions included in the resource data sync.

ResourceDataSyncSourceWithState

resourceDataSyncSourceWithState_awsOrganizationsSource :: Lens' ResourceDataSyncSourceWithState (Maybe ResourceDataSyncAwsOrganizationsSource) Source #

The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.

resourceDataSyncSourceWithState_enableAllOpsDataSources :: Lens' ResourceDataSyncSourceWithState (Maybe Bool) Source #

When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.

resourceDataSyncSourceWithState_includeFutureRegions :: Lens' ResourceDataSyncSourceWithState (Maybe Bool) Source #

Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.

resourceDataSyncSourceWithState_sourceRegions :: Lens' ResourceDataSyncSourceWithState (Maybe [Text]) Source #

The SyncSource Amazon Web Services Regions included in the resource data sync.

resourceDataSyncSourceWithState_sourceType :: Lens' ResourceDataSyncSourceWithState (Maybe Text) Source #

The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or singleAccountMultiRegions.

resourceDataSyncSourceWithState_state :: Lens' ResourceDataSyncSourceWithState (Maybe Text) Source #

The data type name for including resource data sync state. There are four sync states:

OrganizationNotExists: Your organization doesn't exist.

NoPermissions: The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer.

InvalidOrganizationalUnit: You specified or selected an invalid unit in the resource data sync configuration.

TrustedAccessDisabled: You disabled Systems Manager access in the organization in Organizations.

ResultAttribute

resultAttribute_typeName :: Lens' ResultAttribute Text Source #

Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation.

ReviewInformation

reviewInformation_reviewedTime :: Lens' ReviewInformation (Maybe UTCTime) Source #

The time that the reviewer took action on the document review request.

reviewInformation_reviewer :: Lens' ReviewInformation (Maybe Text) Source #

The reviewer assigned to take action on the document review request.

reviewInformation_status :: Lens' ReviewInformation (Maybe ReviewStatus) Source #

The current status of the document review request.

Runbook

runbook_documentVersion :: Lens' Runbook (Maybe Text) Source #

The version of the Automation runbook used in a runbook workflow.

runbook_maxConcurrency :: Lens' Runbook (Maybe Text) Source #

The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

runbook_maxErrors :: Lens' Runbook (Maybe Text) Source #

The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

runbook_parameters :: Lens' Runbook (Maybe (HashMap Text [Text])) Source #

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

runbook_targetLocations :: Lens' Runbook (Maybe (NonEmpty TargetLocation)) Source #

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

runbook_targetMaps :: Lens' Runbook (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

runbook_targetParameterName :: Lens' Runbook (Maybe Text) Source #

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

runbook_targets :: Lens' Runbook (Maybe [Target]) Source #

A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

runbook_documentName :: Lens' Runbook Text Source #

The name of the Automation runbook used in a runbook workflow.

S3OutputLocation

s3OutputLocation_outputS3BucketName :: Lens' S3OutputLocation (Maybe Text) Source #

The name of the S3 bucket.

s3OutputLocation_outputS3KeyPrefix :: Lens' S3OutputLocation (Maybe Text) Source #

The S3 bucket subfolder.

s3OutputLocation_outputS3Region :: Lens' S3OutputLocation (Maybe Text) Source #

The Amazon Web Services Region of the S3 bucket.

S3OutputUrl

s3OutputUrl_outputUrl :: Lens' S3OutputUrl (Maybe Text) Source #

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

ScheduledWindowExecution

scheduledWindowExecution_executionTime :: Lens' ScheduledWindowExecution (Maybe Text) Source #

The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.

scheduledWindowExecution_name :: Lens' ScheduledWindowExecution (Maybe Text) Source #

The name of the maintenance window to be run.

scheduledWindowExecution_windowId :: Lens' ScheduledWindowExecution (Maybe Text) Source #

The ID of the maintenance window to be run.

ServiceSetting

serviceSetting_arn :: Lens' ServiceSetting (Maybe Text) Source #

The ARN of the service setting.

serviceSetting_lastModifiedDate :: Lens' ServiceSetting (Maybe UTCTime) Source #

The last time the service setting was modified.

serviceSetting_lastModifiedUser :: Lens' ServiceSetting (Maybe Text) Source #

The ARN of the last modified user. This field is populated only if the setting value was overwritten.

serviceSetting_settingId :: Lens' ServiceSetting (Maybe Text) Source #

The ID of the service setting.

serviceSetting_settingValue :: Lens' ServiceSetting (Maybe Text) Source #

The value of the service setting.

serviceSetting_status :: Lens' ServiceSetting (Maybe Text) Source #

The status of the service setting. The value can be Default, Customized or PendingUpdate.

Default: The current setting uses a default value provisioned by the Amazon Web Services service team.
Customized: The current setting use a custom value specified by the customer.
PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

Session

session_details :: Lens' Session (Maybe Text) Source #

Reserved for future use.

session_documentName :: Lens' Session (Maybe Text) Source #

The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

session_endDate :: Lens' Session (Maybe UTCTime) Source #

The date and time, in ISO-8601 Extended format, when the session was terminated.

session_maxSessionDuration :: Lens' Session (Maybe Text) Source #

The maximum duration of a session before it terminates.

session_outputUrl :: Lens' Session (Maybe SessionManagerOutputUrl) Source #

Reserved for future use.

session_owner :: Lens' Session (Maybe Text) Source #

The ID of the Amazon Web Services user account that started the session.

session_reason :: Lens' Session (Maybe Text) Source #

The reason for connecting to the instance.

session_sessionId :: Lens' Session (Maybe Text) Source #

The ID of the session.

session_startDate :: Lens' Session (Maybe UTCTime) Source #

The date and time, in ISO-8601 Extended format, when the session began.

session_status :: Lens' Session (Maybe SessionStatus) Source #

The status of the session. For example, "Connected" or "Terminated".

session_target :: Lens' Session (Maybe Text) Source #

The managed node that the Session Manager session connected to.

SessionFilter

sessionFilter_key :: Lens' SessionFilter SessionFilterKey Source #

The name of the filter.

sessionFilter_value :: Lens' SessionFilter Text Source #

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

InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
Target: Specify a managed node to which session connections have been made.
Owner: Specify an Amazon Web Services user account to see a list of sessions started by that user.
Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:
- Connected
- Connecting
- Disconnected
- Terminated
- Terminating
- Failed
SessionId: Specify a session ID to return details about the session.

SessionManagerOutputUrl

sessionManagerOutputUrl_cloudWatchOutputUrl :: Lens' SessionManagerOutputUrl (Maybe Text) Source #

Reserved for future use.

sessionManagerOutputUrl_s3OutputUrl :: Lens' SessionManagerOutputUrl (Maybe Text) Source #

Reserved for future use.

SeveritySummary

severitySummary_criticalCount :: Lens' SeveritySummary (Maybe Int) Source #

The total number of resources or compliance items that have a severity level of Critical. Critical severity is determined by the organization that published the compliance items.

severitySummary_highCount :: Lens' SeveritySummary (Maybe Int) Source #

The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

severitySummary_informationalCount :: Lens' SeveritySummary (Maybe Int) Source #

The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

severitySummary_lowCount :: Lens' SeveritySummary (Maybe Int) Source #

The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

severitySummary_mediumCount :: Lens' SeveritySummary (Maybe Int) Source #

The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

severitySummary_unspecifiedCount :: Lens' SeveritySummary (Maybe Int) Source #

The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

StepExecution

stepExecution_action :: Lens' StepExecution (Maybe Text) Source #

The action this step performs. The action determines the behavior of the step.

stepExecution_executionEndTime :: Lens' StepExecution (Maybe UTCTime) Source #

If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.

stepExecution_executionStartTime :: Lens' StepExecution (Maybe UTCTime) Source #

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.

stepExecution_failureDetails :: Lens' StepExecution (Maybe FailureDetails) Source #

Information about the Automation failure.

stepExecution_failureMessage :: Lens' StepExecution (Maybe Text) Source #

If a step failed, this message explains why the execution failed.

stepExecution_inputs :: Lens' StepExecution (Maybe (HashMap Text Text)) Source #

Fully-resolved values passed into the step before execution.

stepExecution_isCritical :: Lens' StepExecution (Maybe Bool) Source #

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

stepExecution_isEnd :: Lens' StepExecution (Maybe Bool) Source #

The flag which can be used to end automation no matter whether the step succeeds or fails.

stepExecution_maxAttempts :: Lens' StepExecution (Maybe Int) Source #

The maximum number of tries to run the action of the step. The default value is 1.

stepExecution_nextStep :: Lens' StepExecution (Maybe Text) Source #

The next step after the step succeeds.

stepExecution_onFailure :: Lens' StepExecution (Maybe Text) Source #

The action to take if the step fails. The default value is Abort.

stepExecution_outputs :: Lens' StepExecution (Maybe (HashMap Text [Text])) Source #

Returned values from the execution of the step.

stepExecution_overriddenParameters :: Lens' StepExecution (Maybe (HashMap Text [Text])) Source #

A user-specified list of parameters to override when running a step.

stepExecution_response :: Lens' StepExecution (Maybe Text) Source #

A message associated with the response code for an execution.

stepExecution_responseCode :: Lens' StepExecution (Maybe Text) Source #

The response code returned by the execution of the step.

stepExecution_stepExecutionId :: Lens' StepExecution (Maybe Text) Source #

The unique ID of a step execution.

stepExecution_stepName :: Lens' StepExecution (Maybe Text) Source #

The name of this execution step.

stepExecution_stepStatus :: Lens' StepExecution (Maybe AutomationExecutionStatus) Source #

The execution status for this step.

stepExecution_targetLocation :: Lens' StepExecution (Maybe TargetLocation) Source #

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

stepExecution_targets :: Lens' StepExecution (Maybe [Target]) Source #

The targets for the step execution.

stepExecution_timeoutSeconds :: Lens' StepExecution (Maybe Integer) Source #

The timeout seconds of the step.

stepExecution_triggeredAlarms :: Lens' StepExecution (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarms that were invoked by the automation.

stepExecution_validNextSteps :: Lens' StepExecution (Maybe [Text]) Source #

Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

StepExecutionFilter

stepExecutionFilter_key :: Lens' StepExecutionFilter StepExecutionFilterKey Source #

One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.

stepExecutionFilter_values :: Lens' StepExecutionFilter (NonEmpty Text) Source #

The values of the filter key.

Tag

tag_key :: Lens' Tag Text Source #

The name of the tag.

tag_value :: Lens' Tag Text Source #

The value of the tag.

Target

target_key :: Lens' Target (Maybe Text) Source #

User-defined criteria for sending commands that target managed nodes that meet the criteria.

target_values :: Lens' Target (Maybe [Text]) Source #

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

TargetLocation

targetLocation_accounts :: Lens' TargetLocation (Maybe (NonEmpty Text)) Source #

The Amazon Web Services accounts targeted by the current Automation execution.

targetLocation_executionRoleName :: Lens' TargetLocation (Maybe Text) Source #

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

targetLocation_regions :: Lens' TargetLocation (Maybe (NonEmpty Text)) Source #

The Amazon Web Services Regions targeted by the current Automation execution.

targetLocation_targetLocationAlarmConfiguration :: Lens' TargetLocation (Maybe AlarmConfiguration) Source #

Undocumented member.

targetLocation_targetLocationMaxConcurrency :: Lens' TargetLocation (Maybe Text) Source #

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

targetLocation_targetLocationMaxErrors :: Lens' TargetLocation (Maybe Text) Source #

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.