Copyright | (c) 2013-2015 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 |
Amazon EC2 Simple Systems Manager (SSM) enables you to configure and manage your EC2 instances. You can create a configuration document and then associate it with one or more running instances.
You can use a configuration document to automate the following tasks for your Windows instances:
- Join an AWS Directory
- Install, repair, or uninstall software using an MSI package
- Run PowerShell scripts
- Configure CloudWatch Logs to monitor applications and systems
Note that configuration documents are not supported on Linux instances.
See: AWS API Reference
- sSM :: Service
- _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
- _DuplicateInstanceId :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDocument :: 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
- _TooManyUpdates :: AsError a => Getting (First ServiceError) a ServiceError
- _MaxDocumentSizeExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.SSM.DescribeDocument
- module Network.AWS.SSM.CreateAssociation
- module Network.AWS.SSM.CreateDocument
- module Network.AWS.SSM.ListDocuments
- module Network.AWS.SSM.GetDocument
- module Network.AWS.SSM.DescribeAssociation
- module Network.AWS.SSM.UpdateAssociationStatus
- module Network.AWS.SSM.ListAssociations
- module Network.AWS.SSM.DeleteAssociation
- module Network.AWS.SSM.DeleteDocument
- module Network.AWS.SSM.CreateAssociationBatch
- data AssociationFilterKey
- data AssociationStatusName
- data DocumentFilterKey = Name
- data DocumentStatus
- data Fault
- 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)
- 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 CreateAssociationBatchRequestEntry
- createAssociationBatchRequestEntry :: CreateAssociationBatchRequestEntry
- cabreInstanceId :: Lens' CreateAssociationBatchRequestEntry (Maybe Text)
- cabreName :: Lens' CreateAssociationBatchRequestEntry (Maybe Text)
- data DocumentDescription
- documentDescription :: DocumentDescription
- dStatus :: Lens' DocumentDescription (Maybe DocumentStatus)
- dSha1 :: Lens' DocumentDescription (Maybe Text)
- dCreatedDate :: Lens' DocumentDescription (Maybe UTCTime)
- dName :: Lens' DocumentDescription (Maybe Text)
- data DocumentFilter
- documentFilter :: DocumentFilterKey -> Text -> DocumentFilter
- dfKey :: Lens' DocumentFilter DocumentFilterKey
- dfValue :: Lens' DocumentFilter Text
- data DocumentIdentifier
- documentIdentifier :: DocumentIdentifier
- diName :: Lens' DocumentIdentifier (Maybe Text)
- data FailedCreateAssociation
- failedCreateAssociation :: FailedCreateAssociation
- fcaEntry :: Lens' FailedCreateAssociation (Maybe CreateAssociationBatchRequestEntry)
- fcaFault :: Lens' FailedCreateAssociation (Maybe Fault)
- fcaMessage :: Lens' FailedCreateAssociation (Maybe 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
.
AssociatedInstances
_AssociatedInstances :: AsError a => Getting (First ServiceError) a ServiceError Source
You must disassociate a configuration document from all instances before you can delete it.
InvalidInstanceId
_InvalidInstanceId :: AsError a => Getting (First ServiceError) a ServiceError Source
You must specify the ID of a running instance.
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.
DuplicateInstanceId
_DuplicateInstanceId :: AsError a => Getting (First ServiceError) a ServiceError Source
You cannot specify an instance ID in more than one association.
InvalidDocument
_InvalidDocument :: AsError a => Getting (First ServiceError) a ServiceError Source
The configuration document 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 configuration 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.
TooManyUpdates
_TooManyUpdates :: AsError a => Getting (First ServiceError) a ServiceError Source
There are concurrent updates for a resource that supports one update at a time.
MaxDocumentSizeExceeded
_MaxDocumentSizeExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source
The size limit of a configuration document is 64 KB.
DocumentAlreadyExists
_DocumentAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified configuration document already exists.
DocumentLimitExceeded
_DocumentLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source
You can have at most 100 active configuration documents.
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.
DescribeDocument
CreateAssociation
CreateDocument
ListDocuments
GetDocument
module Network.AWS.SSM.GetDocument
DescribeAssociation
UpdateAssociationStatus
ListAssociations
DeleteAssociation
DeleteDocument
CreateAssociationBatch
Types
AssociationFilterKey
data AssociationFilterKey Source
AssociationStatusName
data AssociationStatusName Source
DocumentFilterKey
data DocumentFilterKey Source
DocumentStatus
data DocumentStatus Source
Fault
Association
data Association Source
Describes an association of a configuration 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 an association.
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.
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.
afValue :: Lens' AssociationFilter Text Source
The filter value.
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.
asDate :: Lens' AssociationStatus UTCTime Source
The date when the status changed.
asName :: Lens' AssociationStatus AssociationStatusName Source
The status.
asMessage :: Lens' AssociationStatus Text Source
The reason for the status.
CreateAssociationBatchRequestEntry
data CreateAssociationBatchRequestEntry Source
Describes the association of a configuration 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.
DocumentDescription
data DocumentDescription Source
Describes a configuration 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 configuration document.
dSha1 :: Lens' DocumentDescription (Maybe Text) Source
The SHA1 hash of the document, which you can use for verification purposes.
dCreatedDate :: Lens' DocumentDescription (Maybe UTCTime) Source
The date when the configuration document was created.
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.
dfValue :: Lens' DocumentFilter Text Source
The value of the filter.
DocumentIdentifier
data DocumentIdentifier Source
Describes the name of a configuration 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:
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.