Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- UnsupportedPlatformType
- InvalidPermissionType
- AssociatedInstances
- InvalidInstanceId
- StatusUnchanged
- InvalidNextToken
- InvalidOutputFolder
- InvalidActivationId
- InvalidCommandId
- DuplicateInstanceId
- InvalidResourceType
- InvalidDocument
- InvalidFilterKey
- InvalidInstanceInformationFilterValue
- AssociationAlreadyExists
- InvalidDocumentContent
- AssociationLimitExceeded
- AssociationDoesNotExist
- InternalServerError
- InvalidRole
- TooManyUpdates
- InvalidActivation
- MaxDocumentSizeExceeded
- InvalidDocumentOperation
- InvalidParameters
- InvalidResourceId
- InvalidNotificationConfig
- DocumentPermissionLimit
- DocumentAlreadyExists
- DocumentLimitExceeded
- InvalidFilter
- Waiters
- Operations
- DescribeActivations
- ListTagsForResource
- DescribeDocument
- CreateAssociation
- DeleteActivation
- CreateActivation
- CreateDocument
- RemoveTagsFromResource
- ListCommandInvocations (Paginated)
- ListDocuments (Paginated)
- UpdateManagedInstanceRole
- GetDocument
- AddTagsToResource
- CancelCommand
- DeregisterManagedInstance
- DescribeAssociation
- ModifyDocumentPermission
- UpdateAssociationStatus
- DescribeInstanceInformation
- ListAssociations (Paginated)
- DeleteAssociation
- SendCommand
- ListCommands (Paginated)
- DeleteDocument
- DescribeDocumentPermission
- CreateAssociationBatch
- Types
- AssociationFilterKey
- AssociationStatusName
- CommandFilterKey
- CommandInvocationStatus
- CommandPluginStatus
- CommandStatus
- DescribeActivationsFilterKeys
- DocumentFilterKey
- DocumentHashType
- DocumentParameterType
- DocumentPermissionType
- DocumentStatus
- Fault
- InstanceInformationFilterKey
- NotificationEvent
- NotificationType
- PingStatus
- PlatformType
- ResourceType
- ResourceTypeForTagging
- Activation
- Association
- AssociationDescription
- AssociationFilter
- AssociationStatus
- Command
- CommandFilter
- CommandInvocation
- CommandPlugin
- CreateAssociationBatchRequestEntry
- DescribeActivationsFilter
- DocumentDescription
- DocumentFilter
- DocumentIdentifier
- DocumentParameter
- FailedCreateAssociation
- InstanceInformation
- InstanceInformationFilter
- NotificationConfig
- Tag
Amazon EC2 Simple Systems Manager (SSM) enables you to remotely manage the configuration of your Amazon EC2 instances, virtual machines (VMs), or servers in your on-premises environment or in an environment provided by other cloud providers using scripts, commands, or the Amazon EC2 console. SSM includes an on-demand solution called Amazon EC2 Run Command and a lightweight instance configuration solution called SSM Config.
This references is intended to be used with the EC2 Run Command User Guide for Linux or Windows.
You must register your on-premises servers and VMs through an activation process before you can configure them using Run Command. Registered servers and VMs are called managed instances. For more information, see Setting Up Run Command On Managed Instances (On-Premises Servers and VMs) on Linux or Setting Up Run Command On Managed Instances (On-Premises Servers and VMs) on Windows.
Run Command
Run Command provides an on-demand experience for executing commands. You can use pre-defined SSM documents to perform the actions listed later in this section, or you can create your own documents. With these documents, you can remotely configure your instances by sending commands using the Commands page in the Amazon EC2 console, AWS Tools for Windows PowerShell, the AWS CLI, or AWS SDKs.
Run Command reports the status of the command execution for each instance targeted by a command. You can also audit the command execution to understand who executed commands, when, and what changes were made. By switching between different SSM documents, you can quickly configure your instances with different types of commands. To get started with Run Command, verify that your environment meets the prerequisites for remotely running commands on EC2 instances (Linux or Windows).
SSM Config
SSM Config is a lightweight instance configuration solution. SSM Config is currently only available for Windows instances. With SSM Config, you can specify a setup configuration for your instances. SSM Config is similar to EC2 User Data, which is another way of running one-time scripts or applying settings during instance launch. SSM Config is an extension of this capability. Using SSM documents, you can specify which actions the system should perform on your instances, including which applications to install, which AWS Directory Service directory to join, which Microsoft PowerShell modules to install, etc. If an instance is missing one or more of these configurations, the system makes those changes. By default, the system checks every five minutes to see if there is a new configuration to apply as defined in a new SSM document. If so, the system updates the instances accordingly. In this way, you can remotely maintain a consistent configuration baseline on your instances. SSM Config is available using the AWS CLI or the AWS Tools for Windows PowerShell. For more information, see Managing Windows Instance Configuration.
SSM Config and Run Command include the following pre-defined documents.
Linux
- AWS-RunShellScript to run shell scripts
- AWS-UpdateSSMAgent to update the Amazon SSM agent
Windows
- AWS-JoinDirectoryServiceDomain to join an AWS Directory
- AWS-RunPowerShellScript to run PowerShell commands or scripts
- AWS-UpdateEC2Config to update the EC2Config service
- AWS-ConfigureWindowsUpdate to configure Windows Update settings
- AWS-InstallApplication to install, repair, or uninstall software using an MSI package
- AWS-InstallPowerShellModule to install PowerShell modules
- AWS-ConfigureCloudWatch to configure Amazon CloudWatch Logs to monitor applications and systems
- AWS-ListWindowsInventory to collect information about an EC2 instance running in Windows.
- AWS-FindWindowsUpdates to scan an instance and determines which updates are missing.
- AWS-InstallMissingWindowsUpdates to install missing updates on your EC2 instance.
- AWS-InstallSpecificWindowsUpdates to install one or more specific updates.
The commands or scripts specified in SSM documents run with administrative privilege on your instances because the Amazon SSM agent runs as root on Linux and the EC2Config service runs in the Local System account on Windows. If a user has permission to execute any of the pre-defined SSM documents (any document that begins with AWS-*) then that user also has administrator access to the instance. Delegate access to Run Command and SSM Config judiciously. This becomes extremely important if you create your own SSM documents. Amazon Web Services does not provide guidance about how to create secure SSM documents. You create SSM documents and delegate access to Run Command at your own risk. As a security best practice, we recommend that you assign access to "AWS-*" documents, especially the AWS-RunShellScript document on Linux and the AWS-RunPowerShellScript document on Windows, to trusted administrators only. You can create SSM documents for specific tasks and delegate access to non-administrators.
For information about creating and sharing SSM documents, see the following topics in the SSM User Guide:
- Creating SSM Documents and Sharing SSM Documents (Linux)
- Creating SSM Documents and Sharing SSM Documents (Windows)
- ssm :: Service
- _UnsupportedPlatformType :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPermissionType :: AsError a => Getting (First ServiceError) a ServiceError
- _AssociatedInstances :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInstanceId :: AsError a => Getting (First ServiceError) a ServiceError
- _StatusUnchanged :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidOutputFolder :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidActivationId :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCommandId :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateInstanceId :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidResourceType :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDocument :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFilterKey :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInstanceInformationFilterValue :: AsError a => Getting (First ServiceError) a ServiceError
- _AssociationAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDocumentContent :: AsError a => Getting (First ServiceError) a ServiceError
- _AssociationLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _AssociationDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRole :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyUpdates :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidActivation :: AsError a => Getting (First ServiceError) a ServiceError
- _MaxDocumentSizeExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDocumentOperation :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameters :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidResourceId :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNotificationConfig :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentPermissionLimit :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFilter :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.SSM.DescribeActivations
- module Network.AWS.SSM.ListTagsForResource
- module Network.AWS.SSM.DescribeDocument
- module Network.AWS.SSM.CreateAssociation
- module Network.AWS.SSM.DeleteActivation
- module Network.AWS.SSM.CreateActivation
- module Network.AWS.SSM.CreateDocument
- module Network.AWS.SSM.RemoveTagsFromResource
- module Network.AWS.SSM.ListCommandInvocations
- module Network.AWS.SSM.ListDocuments
- module Network.AWS.SSM.UpdateManagedInstanceRole
- module Network.AWS.SSM.GetDocument
- module Network.AWS.SSM.AddTagsToResource
- module Network.AWS.SSM.CancelCommand
- module Network.AWS.SSM.DeregisterManagedInstance
- module Network.AWS.SSM.DescribeAssociation
- module Network.AWS.SSM.ModifyDocumentPermission
- module Network.AWS.SSM.UpdateAssociationStatus
- module Network.AWS.SSM.DescribeInstanceInformation
- module Network.AWS.SSM.ListAssociations
- module Network.AWS.SSM.DeleteAssociation
- module Network.AWS.SSM.SendCommand
- module Network.AWS.SSM.ListCommands
- module Network.AWS.SSM.DeleteDocument
- module Network.AWS.SSM.DescribeDocumentPermission
- module Network.AWS.SSM.CreateAssociationBatch
- data AssociationFilterKey
- data AssociationStatusName
- data CommandFilterKey
- data CommandInvocationStatus
- data CommandPluginStatus
- data CommandStatus
- data DescribeActivationsFilterKeys
- data DocumentFilterKey
- = Name
- | Owner
- | PlatformTypes
- data DocumentHashType
- data DocumentParameterType
- = String
- | StringList
- data DocumentPermissionType = Share
- data DocumentStatus
- data Fault
- data InstanceInformationFilterKey
- data NotificationEvent
- data NotificationType
- data PingStatus
- data PlatformType
- data ResourceType
- data ResourceTypeForTagging = RTFTManagedInstance
- data Activation
- activation :: Activation
- aExpired :: Lens' Activation (Maybe Bool)
- aDefaultInstanceName :: Lens' Activation (Maybe Text)
- aActivationId :: Lens' Activation (Maybe Text)
- aCreatedDate :: Lens' Activation (Maybe UTCTime)
- aRegistrationLimit :: Lens' Activation (Maybe Natural)
- aExpirationDate :: Lens' Activation (Maybe UTCTime)
- aDescription :: Lens' Activation (Maybe Text)
- aRegistrationsCount :: Lens' Activation (Maybe Natural)
- aIAMRole :: Lens' Activation (Maybe Text)
- data Association
- association :: Association
- aInstanceId :: Lens' Association (Maybe Text)
- aName :: Lens' Association (Maybe Text)
- data AssociationDescription
- associationDescription :: AssociationDescription
- adInstanceId :: Lens' AssociationDescription (Maybe Text)
- adStatus :: Lens' AssociationDescription (Maybe AssociationStatus)
- adDate :: Lens' AssociationDescription (Maybe UTCTime)
- adName :: Lens' AssociationDescription (Maybe Text)
- adParameters :: Lens' AssociationDescription (HashMap Text [Text])
- data AssociationFilter
- associationFilter :: AssociationFilterKey -> Text -> AssociationFilter
- afKey :: Lens' AssociationFilter AssociationFilterKey
- afValue :: Lens' AssociationFilter Text
- data AssociationStatus
- associationStatus :: UTCTime -> AssociationStatusName -> Text -> AssociationStatus
- asAdditionalInfo :: Lens' AssociationStatus (Maybe Text)
- asDate :: Lens' AssociationStatus UTCTime
- asName :: Lens' AssociationStatus AssociationStatusName
- asMessage :: Lens' AssociationStatus Text
- data Command
- command :: Command
- cStatus :: Lens' Command (Maybe CommandStatus)
- cExpiresAfter :: Lens' Command (Maybe UTCTime)
- cNotificationConfig :: Lens' Command (Maybe NotificationConfig)
- cOutputS3KeyPrefix :: Lens' Command (Maybe Text)
- cDocumentName :: Lens' Command (Maybe Text)
- cInstanceIds :: Lens' Command (Maybe (NonEmpty Text))
- cCommandId :: Lens' Command (Maybe Text)
- cParameters :: Lens' Command (HashMap Text [Text])
- cComment :: Lens' Command (Maybe Text)
- cOutputS3BucketName :: Lens' Command (Maybe Text)
- cRequestedDateTime :: Lens' Command (Maybe UTCTime)
- cServiceRole :: Lens' Command (Maybe Text)
- data CommandFilter
- commandFilter :: CommandFilterKey -> Text -> CommandFilter
- cfKey :: Lens' CommandFilter CommandFilterKey
- cfValue :: Lens' CommandFilter Text
- data CommandInvocation
- commandInvocation :: CommandInvocation
- ciInstanceId :: Lens' CommandInvocation (Maybe Text)
- ciStatus :: Lens' CommandInvocation (Maybe CommandInvocationStatus)
- ciNotificationConfig :: Lens' CommandInvocation (Maybe NotificationConfig)
- ciCommandPlugins :: Lens' CommandInvocation [CommandPlugin]
- ciDocumentName :: Lens' CommandInvocation (Maybe Text)
- ciCommandId :: Lens' CommandInvocation (Maybe Text)
- ciComment :: Lens' CommandInvocation (Maybe Text)
- ciTraceOutput :: Lens' CommandInvocation (Maybe Text)
- ciRequestedDateTime :: Lens' CommandInvocation (Maybe UTCTime)
- ciServiceRole :: Lens' CommandInvocation (Maybe Text)
- data CommandPlugin
- commandPlugin :: CommandPlugin
- cpStatus :: Lens' CommandPlugin (Maybe CommandPluginStatus)
- cpResponseStartDateTime :: Lens' CommandPlugin (Maybe UTCTime)
- cpOutputS3KeyPrefix :: Lens' CommandPlugin (Maybe Text)
- cpResponseCode :: Lens' CommandPlugin (Maybe Int)
- cpOutput :: Lens' CommandPlugin (Maybe Text)
- cpName :: Lens' CommandPlugin (Maybe Text)
- cpOutputS3BucketName :: Lens' CommandPlugin (Maybe Text)
- cpResponseFinishDateTime :: Lens' CommandPlugin (Maybe UTCTime)
- data CreateAssociationBatchRequestEntry
- createAssociationBatchRequestEntry :: CreateAssociationBatchRequestEntry
- cabreInstanceId :: Lens' CreateAssociationBatchRequestEntry (Maybe Text)
- cabreName :: Lens' CreateAssociationBatchRequestEntry (Maybe Text)
- cabreParameters :: Lens' CreateAssociationBatchRequestEntry (HashMap Text [Text])
- data DescribeActivationsFilter
- describeActivationsFilter :: DescribeActivationsFilter
- dafFilterKey :: Lens' DescribeActivationsFilter (Maybe DescribeActivationsFilterKeys)
- dafFilterValues :: Lens' DescribeActivationsFilter [Text]
- data DocumentDescription
- documentDescription :: DocumentDescription
- dStatus :: Lens' DocumentDescription (Maybe DocumentStatus)
- dHash :: Lens' DocumentDescription (Maybe Text)
- dSha1 :: Lens' DocumentDescription (Maybe Text)
- dOwner :: Lens' DocumentDescription (Maybe Text)
- dPlatformTypes :: Lens' DocumentDescription [PlatformType]
- dCreatedDate :: Lens' DocumentDescription (Maybe UTCTime)
- dName :: Lens' DocumentDescription (Maybe Text)
- dHashType :: Lens' DocumentDescription (Maybe DocumentHashType)
- dParameters :: Lens' DocumentDescription [DocumentParameter]
- dDescription :: Lens' DocumentDescription (Maybe Text)
- data DocumentFilter
- documentFilter :: DocumentFilterKey -> Text -> DocumentFilter
- dfKey :: Lens' DocumentFilter DocumentFilterKey
- dfValue :: Lens' DocumentFilter Text
- data DocumentIdentifier
- documentIdentifier :: DocumentIdentifier
- diOwner :: Lens' DocumentIdentifier (Maybe Text)
- diPlatformTypes :: Lens' DocumentIdentifier [PlatformType]
- diName :: Lens' DocumentIdentifier (Maybe Text)
- data DocumentParameter
- documentParameter :: DocumentParameter
- dpName :: Lens' DocumentParameter (Maybe Text)
- dpDefaultValue :: Lens' DocumentParameter (Maybe Text)
- dpType :: Lens' DocumentParameter (Maybe DocumentParameterType)
- dpDescription :: Lens' DocumentParameter (Maybe Text)
- data FailedCreateAssociation
- failedCreateAssociation :: FailedCreateAssociation
- fcaEntry :: Lens' FailedCreateAssociation (Maybe CreateAssociationBatchRequestEntry)
- fcaFault :: Lens' FailedCreateAssociation (Maybe Fault)
- fcaMessage :: Lens' FailedCreateAssociation (Maybe Text)
- data InstanceInformation
- instanceInformation :: InstanceInformation
- iiInstanceId :: Lens' InstanceInformation (Maybe Text)
- iiPingStatus :: Lens' InstanceInformation (Maybe PingStatus)
- iiIPAddress :: Lens' InstanceInformation (Maybe Text)
- iiResourceType :: Lens' InstanceInformation (Maybe ResourceType)
- iiRegistrationDate :: Lens' InstanceInformation (Maybe UTCTime)
- iiPlatformVersion :: Lens' InstanceInformation (Maybe Text)
- iiIsLatestVersion :: Lens' InstanceInformation (Maybe Bool)
- iiAgentVersion :: Lens' InstanceInformation (Maybe Text)
- iiLastPingDateTime :: Lens' InstanceInformation (Maybe UTCTime)
- iiActivationId :: Lens' InstanceInformation (Maybe Text)
- iiName :: Lens' InstanceInformation (Maybe Text)
- iiPlatformType :: Lens' InstanceInformation (Maybe PlatformType)
- iiPlatformName :: Lens' InstanceInformation (Maybe Text)
- iiComputerName :: Lens' InstanceInformation (Maybe Text)
- iiIAMRole :: Lens' InstanceInformation (Maybe Text)
- data InstanceInformationFilter
- instanceInformationFilter :: InstanceInformationFilterKey -> NonEmpty Text -> InstanceInformationFilter
- iifKey :: Lens' InstanceInformationFilter InstanceInformationFilterKey
- iifValueSet :: Lens' InstanceInformationFilter (NonEmpty Text)
- data NotificationConfig
- notificationConfig :: NotificationConfig
- ncNotificationEvents :: Lens' NotificationConfig [NotificationEvent]
- ncNotificationType :: Lens' NotificationConfig (Maybe NotificationType)
- ncNotificationARN :: Lens' NotificationConfig (Maybe Text)
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
Service Configuration
API version '2014-11-06' of the Amazon Simple Systems Management Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SSM
.
UnsupportedPlatformType
_UnsupportedPlatformType :: AsError a => Getting (First ServiceError) a ServiceError Source #
The document does not support the platform type of the given instance ID(s). For example, you sent an SSM document for a Windows instance to a Linux instance.
InvalidPermissionType
_InvalidPermissionType :: AsError a => Getting (First ServiceError) a ServiceError Source #
The permission type is not supported. Share is the only supported permission type.
AssociatedInstances
_AssociatedInstances :: AsError a => Getting (First ServiceError) a ServiceError Source #
You must disassociate an SSM document from all instances before you can delete it.
InvalidInstanceId
_InvalidInstanceId :: AsError a => Getting (First ServiceError) a ServiceError Source #
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
StatusUnchanged
_StatusUnchanged :: AsError a => Getting (First ServiceError) a ServiceError Source #
The updated status is the same as the current status.
InvalidNextToken
_InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified token is not valid.
InvalidOutputFolder
_InvalidOutputFolder :: AsError a => Getting (First ServiceError) a ServiceError Source #
The S3 bucket does not exist.
InvalidActivationId
_InvalidActivationId :: AsError a => Getting (First ServiceError) a ServiceError Source #
The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
InvalidCommandId
_InvalidCommandId :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for InvalidCommandId' errors.
DuplicateInstanceId
_DuplicateInstanceId :: AsError a => Getting (First ServiceError) a ServiceError Source #
You cannot specify an instance ID in more than one association.
InvalidResourceType
_InvalidResourceType :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource type is not valid. If you are attempting to tag an instance, the instance must be a registered, managed instance.
InvalidDocument
_InvalidDocument :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified document does not exist.
InvalidFilterKey
_InvalidFilterKey :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified key is not valid.
InvalidInstanceInformationFilterValue
_InvalidInstanceInformationFilterValue :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified filter value is not valid.
AssociationAlreadyExists
_AssociationAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified association already exists.
InvalidDocumentContent
_InvalidDocumentContent :: AsError a => Getting (First ServiceError) a ServiceError Source #
The content for the SSM document is not valid.
AssociationLimitExceeded
_AssociationLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can have at most 2,000 active associations.
AssociationDoesNotExist
_AssociationDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified association does not exist.
InternalServerError
_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred on the server side.
InvalidRole
_InvalidRole :: AsError a => Getting (First ServiceError) a ServiceError Source #
The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for SSM notifications, see Configuring SNS Notifications SSM in the Amazon Elastic Compute Cloud User Guide .
TooManyUpdates
_TooManyUpdates :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are concurrent updates for a resource that supports one update at a time.
InvalidActivation
_InvalidActivation :: AsError a => Getting (First ServiceError) a ServiceError Source #
The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.
MaxDocumentSizeExceeded
_MaxDocumentSizeExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The size limit of an SSM document is 64 KB.
InvalidDocumentOperation
_InvalidDocumentOperation :: AsError a => Getting (First ServiceError) a ServiceError Source #
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
InvalidParameters
_InvalidParameters :: AsError a => Getting (First ServiceError) a ServiceError Source #
You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document.
InvalidResourceId
_InvalidResourceId :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource ID is not valid. Verify that you entered the correct ID and try again.
InvalidNotificationConfig
_InvalidNotificationConfig :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.
DocumentPermissionLimit
_DocumentPermissionLimit :: AsError a => Getting (First ServiceError) a ServiceError Source #
The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS Support.
DocumentAlreadyExists
_DocumentAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified SSM document already exists.
DocumentLimitExceeded
_DocumentLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can have at most 200 active SSM documents.
InvalidFilter
_InvalidFilter :: AsError a => Getting (First ServiceError) a ServiceError Source #
The filter name is not valid. Verify the you entered the correct name and try again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeActivations
ListTagsForResource
DescribeDocument
CreateAssociation
DeleteActivation
CreateActivation
CreateDocument
RemoveTagsFromResource
ListCommandInvocations (Paginated)
ListDocuments (Paginated)
UpdateManagedInstanceRole
GetDocument
module Network.AWS.SSM.GetDocument
AddTagsToResource
CancelCommand
DeregisterManagedInstance
DescribeAssociation
ModifyDocumentPermission
UpdateAssociationStatus
DescribeInstanceInformation
ListAssociations (Paginated)
DeleteAssociation
SendCommand
module Network.AWS.SSM.SendCommand
ListCommands (Paginated)
module Network.AWS.SSM.ListCommands
DeleteDocument
DescribeDocumentPermission
CreateAssociationBatch
Types
AssociationFilterKey
data AssociationFilterKey Source #
AssociationStatusName
data AssociationStatusName Source #
CommandFilterKey
data CommandFilterKey Source #
CommandInvocationStatus
data CommandInvocationStatus Source #
CommandPluginStatus
data CommandPluginStatus Source #
CommandStatus
data CommandStatus Source #
DescribeActivationsFilterKeys
data DescribeActivationsFilterKeys Source #
DocumentFilterKey
data DocumentFilterKey Source #
DocumentHashType
data DocumentHashType Source #
DocumentParameterType
data DocumentParameterType Source #
DocumentPermissionType
data DocumentPermissionType Source #
DocumentStatus
data DocumentStatus Source #
Fault
InstanceInformationFilterKey
data InstanceInformationFilterKey Source #
IIFKActivationIds | |
IIFKAgentVersion | |
IIFKIAMRole | |
IIFKInstanceIds | |
IIFKPingStatus | |
IIFKPlatformTypes | |
IIFKResourceType |
NotificationEvent
data NotificationEvent Source #
NotificationType
data NotificationType Source #
PingStatus
data PingStatus Source #
PlatformType
data PlatformType Source #
ResourceType
data ResourceType Source #
ResourceTypeForTagging
data ResourceTypeForTagging Source #
Activation
data Activation Source #
An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.
See: activation
smart constructor.
activation :: Activation Source #
Creates a value of Activation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aDefaultInstanceName :: Lens' Activation (Maybe Text) Source #
A name for the managed instance when it is created.
aActivationId :: Lens' Activation (Maybe Text) Source #
The ID created by SSM when you submitted the activation.
aCreatedDate :: Lens' Activation (Maybe UTCTime) Source #
The date the activation was created.
aRegistrationLimit :: Lens' Activation (Maybe Natural) Source #
The maximum number of managed instances that can be registered using this activation.
aExpirationDate :: Lens' Activation (Maybe UTCTime) Source #
The date when this activation can no longer be used to register managed instances.
aDescription :: Lens' Activation (Maybe Text) Source #
A user defined description of the activation.
aRegistrationsCount :: Lens' Activation (Maybe Natural) Source #
The number of managed instances already registered with this activation.
aIAMRole :: Lens' Activation (Maybe Text) Source #
The Amazon Identity and Access Management (IAM) role to assign to the managed instance.
Association
data Association Source #
Describes an association of an SSM document and an instance.
See: association
smart constructor.
association :: Association Source #
Creates a value of Association
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aInstanceId :: Lens' Association (Maybe Text) Source #
The ID of the instance.
AssociationDescription
data AssociationDescription Source #
Describes the parameters for a document.
See: associationDescription
smart constructor.
associationDescription :: AssociationDescription Source #
Creates a value of AssociationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
adInstanceId :: Lens' AssociationDescription (Maybe Text) Source #
The ID of the instance.
adStatus :: Lens' AssociationDescription (Maybe AssociationStatus) Source #
The association status.
adDate :: Lens' AssociationDescription (Maybe UTCTime) Source #
The date when the association was made.
adParameters :: Lens' AssociationDescription (HashMap Text [Text]) Source #
A description of the parameters for a document.
AssociationFilter
data AssociationFilter Source #
Describes a filter.
See: associationFilter
smart constructor.
Creates a value of AssociationFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
afKey :: Lens' AssociationFilter AssociationFilterKey Source #
The name of the filter.
AssociationStatus
data AssociationStatus Source #
Describes an association status.
See: associationStatus
smart constructor.
Creates a value of AssociationStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asAdditionalInfo :: Lens' AssociationStatus (Maybe Text) Source #
A user-defined string.
asName :: Lens' AssociationStatus AssociationStatusName Source #
The status.
Command
Describes a command request.
See: command
smart constructor.
Creates a value of Command
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cExpiresAfter :: Lens' Command (Maybe UTCTime) Source #
If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
cNotificationConfig :: Lens' Command (Maybe NotificationConfig) Source #
Configurations for sending notifications about command status changes.
cOutputS3KeyPrefix :: 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.
cDocumentName :: Lens' Command (Maybe Text) Source #
The name of the SSM document requested for execution.
cInstanceIds :: Lens' Command (Maybe (NonEmpty Text)) Source #
The instance IDs against which this command was requested.
cParameters :: Lens' Command (HashMap Text [Text]) Source #
The parameter values to be inserted in the SSM document when executing the command.
cComment :: Lens' Command (Maybe Text) Source #
User-specified information about the command, such as a brief description of what the command should do.
cOutputS3BucketName :: 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.
cRequestedDateTime :: Lens' Command (Maybe UTCTime) Source #
The date and time the command was requested.
cServiceRole :: Lens' Command (Maybe Text) Source #
The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes.
CommandFilter
data CommandFilter Source #
Describes a command filter.
See: commandFilter
smart constructor.
Creates a value of CommandFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfKey :: Lens' CommandFilter CommandFilterKey Source #
The name of the filter. For example, requested date and time.
CommandInvocation
data CommandInvocation Source #
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you executed.
See: commandInvocation
smart constructor.
commandInvocation :: CommandInvocation Source #
Creates a value of CommandInvocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ciInstanceId :: Lens' CommandInvocation (Maybe Text) Source #
The instance ID in which this invocation was requested.
ciStatus :: Lens' CommandInvocation (Maybe CommandInvocationStatus) Source #
Whether or not the invocation succeeded, failed, or is pending.
ciNotificationConfig :: Lens' CommandInvocation (Maybe NotificationConfig) Source #
Configurations for sending notifications about command status changes on a per instance basis.
ciCommandPlugins :: Lens' CommandInvocation [CommandPlugin] Source #
Undocumented member.
ciDocumentName :: Lens' CommandInvocation (Maybe Text) Source #
The document name that was requested for execution.
ciCommandId :: Lens' CommandInvocation (Maybe Text) Source #
The command against which this invocation was requested.
ciComment :: Lens' CommandInvocation (Maybe Text) Source #
User-specified information about the command, such as a brief description of what the command should do.
ciTraceOutput :: Lens' CommandInvocation (Maybe Text) Source #
Gets the trace output sent by the agent.
ciRequestedDateTime :: Lens' CommandInvocation (Maybe UTCTime) Source #
The time and date the request was sent to this instance.
ciServiceRole :: Lens' CommandInvocation (Maybe Text) Source #
The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes on a per instance basis.
CommandPlugin
data CommandPlugin Source #
Describes plugin details.
See: commandPlugin
smart constructor.
commandPlugin :: CommandPlugin Source #
Creates a value of CommandPlugin
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cpStatus :: Lens' CommandPlugin (Maybe CommandPluginStatus) Source #
The status of this plugin. You can execute a document with multiple plugins.
cpResponseStartDateTime :: Lens' CommandPlugin (Maybe UTCTime) Source #
The time the plugin started executing.
cpOutputS3KeyPrefix :: 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.
cpResponseCode :: Lens' CommandPlugin (Maybe Int) Source #
A numeric response code generated after executing the plugin.
cpName :: 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.
cpOutputS3BucketName :: 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.
cpResponseFinishDateTime :: Lens' CommandPlugin (Maybe UTCTime) Source #
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
CreateAssociationBatchRequestEntry
data CreateAssociationBatchRequestEntry Source #
Describes the association of an SSM document and an instance.
See: createAssociationBatchRequestEntry
smart constructor.
createAssociationBatchRequestEntry :: CreateAssociationBatchRequestEntry Source #
Creates a value of CreateAssociationBatchRequestEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cabreInstanceId :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #
The ID of the instance.
cabreName :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #
The name of the configuration document.
cabreParameters :: Lens' CreateAssociationBatchRequestEntry (HashMap Text [Text]) Source #
A description of the parameters for a document.
DescribeActivationsFilter
data DescribeActivationsFilter Source #
Filter for the DescribeActivation API.
See: describeActivationsFilter
smart constructor.
describeActivationsFilter :: DescribeActivationsFilter Source #
Creates a value of DescribeActivationsFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dafFilterKey :: Lens' DescribeActivationsFilter (Maybe DescribeActivationsFilterKeys) Source #
The name of the filter.
dafFilterValues :: Lens' DescribeActivationsFilter [Text] Source #
The filter values.
DocumentDescription
data DocumentDescription Source #
Describes an SSM document.
See: documentDescription
smart constructor.
documentDescription :: DocumentDescription Source #
Creates a value of DocumentDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dStatus :: Lens' DocumentDescription (Maybe DocumentStatus) Source #
The status of the SSM document.
dHash :: Lens' DocumentDescription (Maybe Text) Source #
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
dSha1 :: Lens' DocumentDescription (Maybe Text) Source #
The SHA1 hash of the document, which you can use for verification purposes.
dOwner :: Lens' DocumentDescription (Maybe Text) Source #
The AWS user account of the person who created the document.
dPlatformTypes :: Lens' DocumentDescription [PlatformType] Source #
The list of OS platforms compatible with this SSM document.
dCreatedDate :: Lens' DocumentDescription (Maybe UTCTime) Source #
The date when the SSM document was created.
dHashType :: Lens' DocumentDescription (Maybe DocumentHashType) Source #
Sha256 or Sha1.
Sha1 hashes have been deprecated.
dParameters :: Lens' DocumentDescription [DocumentParameter] Source #
A description of the parameters for a document.
dDescription :: Lens' DocumentDescription (Maybe Text) Source #
A description of the document.
DocumentFilter
data DocumentFilter Source #
Describes a filter.
See: documentFilter
smart constructor.
Creates a value of DocumentFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dfKey :: Lens' DocumentFilter DocumentFilterKey Source #
The name of the filter.
DocumentIdentifier
data DocumentIdentifier Source #
Describes the name of an SSM document.
See: documentIdentifier
smart constructor.
documentIdentifier :: DocumentIdentifier Source #
Creates a value of DocumentIdentifier
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
diOwner :: Lens' DocumentIdentifier (Maybe Text) Source #
The AWS user account of the person who created the document.
diPlatformTypes :: Lens' DocumentIdentifier [PlatformType] Source #
The operating system platform.
DocumentParameter
data DocumentParameter Source #
Parameters specified in the SSM document that execute on the server when the command is run.
See: documentParameter
smart constructor.
documentParameter :: DocumentParameter Source #
Creates a value of DocumentParameter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpDefaultValue :: 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.
dpType :: Lens' DocumentParameter (Maybe DocumentParameterType) Source #
The type of parameter. The type can be either “String” or “StringList”.
dpDescription :: 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.
FailedCreateAssociation
data FailedCreateAssociation Source #
Describes a failed association.
See: failedCreateAssociation
smart constructor.
failedCreateAssociation :: FailedCreateAssociation Source #
Creates a value of FailedCreateAssociation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fcaEntry :: Lens' FailedCreateAssociation (Maybe CreateAssociationBatchRequestEntry) Source #
The association.
fcaMessage :: Lens' FailedCreateAssociation (Maybe Text) Source #
A description of the failure.
InstanceInformation
data InstanceInformation Source #
Describes a filter for a specific list of instances.
See: instanceInformation
smart constructor.
instanceInformation :: InstanceInformation Source #
Creates a value of InstanceInformation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iiInstanceId :: Lens' InstanceInformation (Maybe Text) Source #
The instance ID.
iiPingStatus :: Lens' InstanceInformation (Maybe PingStatus) Source #
Connection status of the SSM agent.
iiIPAddress :: Lens' InstanceInformation (Maybe Text) Source #
The IP address of the managed instance.
iiResourceType :: Lens' InstanceInformation (Maybe ResourceType) Source #
The type of instance. Instances are either EC2 instances or managed instances.
iiRegistrationDate :: Lens' InstanceInformation (Maybe UTCTime) Source #
The date the server or VM was registered with AWS as a managed instance.
iiPlatformVersion :: Lens' InstanceInformation (Maybe Text) Source #
The version of the OS platform running on your instance.
iiIsLatestVersion :: Lens' InstanceInformation (Maybe Bool) Source #
Indicates whether latest version of the SSM agent is running on your instance.
iiAgentVersion :: Lens' InstanceInformation (Maybe Text) Source #
The version of the SSM agent running on your Linux instance.
iiLastPingDateTime :: Lens' InstanceInformation (Maybe UTCTime) Source #
The date and time when agent last pinged SSM service.
iiActivationId :: Lens' InstanceInformation (Maybe Text) Source #
The activation ID created by SSM when the server or VM was registered.
iiPlatformType :: Lens' InstanceInformation (Maybe PlatformType) Source #
The operating system platform type.
iiPlatformName :: Lens' InstanceInformation (Maybe Text) Source #
The name of the operating system platform running on your instance.
iiComputerName :: Lens' InstanceInformation (Maybe Text) Source #
The fully qualified host name of the managed instance.
iiIAMRole :: Lens' InstanceInformation (Maybe Text) Source #
The Amazon Identity and Access Management (IAM) role assigned to EC2 instances or managed instances.
InstanceInformationFilter
data InstanceInformationFilter Source #
Describes a filter for a specific list of instances.
See: instanceInformationFilter
smart constructor.
instanceInformationFilter Source #
Creates a value of InstanceInformationFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iifKey :: Lens' InstanceInformationFilter InstanceInformationFilterKey Source #
The name of the filter.
iifValueSet :: Lens' InstanceInformationFilter (NonEmpty Text) Source #
The filter values.
NotificationConfig
data NotificationConfig Source #
Configurations for sending notifications.
See: notificationConfig
smart constructor.
notificationConfig :: NotificationConfig Source #
Creates a value of NotificationConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ncNotificationEvents :: Lens' NotificationConfig [NotificationEvent] Source #
The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Monitoring Commands in the Amazon Elastic Compute Cloud User Guide .
ncNotificationType :: Lens' NotificationConfig (Maybe NotificationType) Source #
Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
ncNotificationARN :: Lens' NotificationConfig (Maybe Text) Source #
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. SSM pushes notifications about command status changes to this topic.
Tag
Metadata that you assign to your managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment.
See: tag
smart constructor.