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
- AssociationFilterKey
- AssociationStatusName
- AutomationExecutionFilterKey
- AutomationExecutionStatus
- CommandFilterKey
- CommandInvocationStatus
- CommandPluginStatus
- CommandStatus
- DescribeActivationsFilterKeys
- DocumentFilterKey
- DocumentHashType
- DocumentParameterType
- DocumentPermissionType
- DocumentStatus
- DocumentType
- Fault
- InstanceInformationFilterKey
- InventoryAttributeDataType
- InventoryQueryOperatorType
- MaintenanceWindowExecutionStatus
- MaintenanceWindowResourceType
- MaintenanceWindowTaskType
- NotificationEvent
- NotificationType
- ParameterType
- ParametersFilterKey
- PingStatus
- PlatformType
- ResourceType
- ResourceTypeForTagging
- Activation
- Association
- AssociationDescription
- AssociationFilter
- AssociationOverview
- AssociationStatus
- AutomationExecution
- AutomationExecutionFilter
- AutomationExecutionMetadata
- Command
- CommandFilter
- CommandInvocation
- CommandPlugin
- CreateAssociationBatchRequestEntry
- DescribeActivationsFilter
- DocumentDefaultVersionDescription
- DocumentDescription
- DocumentFilter
- DocumentIdentifier
- DocumentParameter
- DocumentVersionInfo
- FailedCreateAssociation
- InstanceAggregatedAssociationOverview
- InstanceAssociation
- InstanceAssociationOutputLocation
- InstanceAssociationOutputURL
- InstanceAssociationStatusInfo
- InstanceInformation
- InstanceInformationFilter
- InstanceInformationStringFilter
- InventoryFilter
- InventoryItem
- InventoryItemAttribute
- InventoryItemSchema
- InventoryResultEntity
- InventoryResultItem
- LoggingInfo
- MaintenanceWindowExecution
- MaintenanceWindowExecutionTaskIdentity
- MaintenanceWindowExecutionTaskInvocationIdentity
- MaintenanceWindowFilter
- MaintenanceWindowIdentity
- MaintenanceWindowTarget
- MaintenanceWindowTask
- MaintenanceWindowTaskParameterValueExpression
- NotificationConfig
- Parameter
- ParameterHistory
- ParameterMetadata
- ParametersFilter
- ResultAttribute
- S3OutputLocation
- S3OutputURL
- StepExecution
- Tag
- Target
- ssm :: Service
- _AutomationDefinitionVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDocumentVersion :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSchedule :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedParameterType :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPluginName :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedPlatformType :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFilterValue :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidItemContentException :: 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
- _InvalidResultAttributeException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceLimitExceededException :: 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
- _UnsupportedInventorySchemaVersionException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDocument :: AsError a => Getting (First ServiceError) a ServiceError
- _AutomationDefinitionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFilterKey :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidAutomationExecutionParametersException :: AsError a => Getting (First ServiceError) a ServiceError
- _AutomationExecutionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTypeNameException :: AsError a => Getting (First ServiceError) a ServiceError
- _ItemSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _DoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _AutomationExecutionLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _IdempotentParameterMismatch :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInstanceInformationFilterValue :: AsError a => Getting (First ServiceError) a ServiceError
- _ItemContentMismatchException :: AsError a => Getting (First ServiceError) a ServiceError
- _ParameterAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _AssociationAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDocumentContent :: AsError a => Getting (First ServiceError) a ServiceError
- _ParameterLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _AssociationLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _AssociationDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError
- _ParameterNotFound :: 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
- _InvalidDocumentSchemaVersion :: AsError a => Getting (First ServiceError) a ServiceError
- _MaxDocumentSizeExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidUpdate :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomSchemaCountLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTarget :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDocumentOperation :: AsError a => Getting (First ServiceError) a ServiceError
- _InvocationDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentVersionLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidOutputLocation :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidKeyId :: 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
- _TotalSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsError :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentPermissionLimit :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateDocumentContent :: 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
- data AssociationFilterKey
- data AssociationStatusName
- data AutomationExecutionFilterKey
- data AutomationExecutionStatus
- data CommandFilterKey
- data CommandInvocationStatus
- data CommandPluginStatus
- data CommandStatus
- data DescribeActivationsFilterKeys
- data DocumentFilterKey
- data DocumentHashType
- data DocumentParameterType
- data DocumentPermissionType = Share
- data DocumentStatus
- data DocumentType
- data Fault
- data InstanceInformationFilterKey
- data InventoryAttributeDataType
- data InventoryQueryOperatorType
- data MaintenanceWindowExecutionStatus
- data MaintenanceWindowResourceType = Instance
- data MaintenanceWindowTaskType = RunCommand
- data NotificationEvent
- data NotificationType
- data ParameterType
- data ParametersFilterKey
- data PingStatus
- data PlatformType
- data ResourceType
- data ResourceTypeForTagging
- 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
- aAssociationId :: Lens' Association (Maybe Text)
- aInstanceId :: Lens' Association (Maybe Text)
- aOverview :: Lens' Association (Maybe AssociationOverview)
- aLastExecutionDate :: Lens' Association (Maybe UTCTime)
- aScheduleExpression :: Lens' Association (Maybe Text)
- aName :: Lens' Association (Maybe Text)
- aTargets :: Lens' Association [Target]
- aDocumentVersion :: Lens' Association (Maybe Text)
- data AssociationDescription
- associationDescription :: AssociationDescription
- adAssociationId :: Lens' AssociationDescription (Maybe Text)
- adInstanceId :: Lens' AssociationDescription (Maybe Text)
- adStatus :: Lens' AssociationDescription (Maybe AssociationStatus)
- adLastSuccessfulExecutionDate :: Lens' AssociationDescription (Maybe UTCTime)
- adOverview :: Lens' AssociationDescription (Maybe AssociationOverview)
- adLastUpdateAssociationDate :: Lens' AssociationDescription (Maybe UTCTime)
- adDate :: Lens' AssociationDescription (Maybe UTCTime)
- adLastExecutionDate :: Lens' AssociationDescription (Maybe UTCTime)
- adScheduleExpression :: Lens' AssociationDescription (Maybe Text)
- adName :: Lens' AssociationDescription (Maybe Text)
- adOutputLocation :: Lens' AssociationDescription (Maybe InstanceAssociationOutputLocation)
- adTargets :: Lens' AssociationDescription [Target]
- adParameters :: Lens' AssociationDescription (HashMap Text [Text])
- adDocumentVersion :: Lens' AssociationDescription (Maybe Text)
- data AssociationFilter
- associationFilter :: AssociationFilterKey -> Text -> AssociationFilter
- afKey :: Lens' AssociationFilter AssociationFilterKey
- afValue :: Lens' AssociationFilter Text
- data AssociationOverview
- associationOverview :: AssociationOverview
- aoDetailedStatus :: Lens' AssociationOverview (Maybe Text)
- aoStatus :: Lens' AssociationOverview (Maybe Text)
- aoAssociationStatusAggregatedCount :: Lens' AssociationOverview (HashMap Text Int)
- 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 AutomationExecution
- automationExecution :: AutomationExecution
- aeDocumentName :: Lens' AutomationExecution (Maybe Text)
- aeExecutionEndTime :: Lens' AutomationExecution (Maybe UTCTime)
- aeFailureMessage :: Lens' AutomationExecution (Maybe Text)
- aeAutomationExecutionStatus :: Lens' AutomationExecution (Maybe AutomationExecutionStatus)
- aeOutputs :: Lens' AutomationExecution (HashMap Text [Text])
- aeExecutionStartTime :: Lens' AutomationExecution (Maybe UTCTime)
- aeParameters :: Lens' AutomationExecution (HashMap Text [Text])
- aeDocumentVersion :: Lens' AutomationExecution (Maybe Text)
- aeAutomationExecutionId :: Lens' AutomationExecution (Maybe Text)
- aeStepExecutions :: Lens' AutomationExecution [StepExecution]
- data AutomationExecutionFilter
- automationExecutionFilter :: AutomationExecutionFilterKey -> NonEmpty Text -> AutomationExecutionFilter
- aefKey :: Lens' AutomationExecutionFilter AutomationExecutionFilterKey
- aefValues :: Lens' AutomationExecutionFilter (NonEmpty Text)
- data AutomationExecutionMetadata
- automationExecutionMetadata :: AutomationExecutionMetadata
- aemLogFile :: Lens' AutomationExecutionMetadata (Maybe Text)
- aemExecutedBy :: Lens' AutomationExecutionMetadata (Maybe Text)
- aemDocumentName :: Lens' AutomationExecutionMetadata (Maybe Text)
- aemExecutionEndTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime)
- aemAutomationExecutionStatus :: Lens' AutomationExecutionMetadata (Maybe AutomationExecutionStatus)
- aemOutputs :: Lens' AutomationExecutionMetadata (HashMap Text [Text])
- aemExecutionStartTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime)
- aemDocumentVersion :: Lens' AutomationExecutionMetadata (Maybe Text)
- aemAutomationExecutionId :: Lens' AutomationExecutionMetadata (Maybe Text)
- data Command
- command :: Command
- cStatus :: Lens' Command (Maybe CommandStatus)
- cExpiresAfter :: Lens' Command (Maybe UTCTime)
- cNotificationConfig :: Lens' Command (Maybe NotificationConfig)
- cTargetCount :: Lens' Command (Maybe Int)
- cOutputS3KeyPrefix :: Lens' Command (Maybe Text)
- cDocumentName :: Lens' Command (Maybe Text)
- cErrorCount :: Lens' Command (Maybe Int)
- cStatusDetails :: Lens' Command (Maybe Text)
- cMaxErrors :: Lens' Command (Maybe Text)
- cInstanceIds :: Lens' Command [Text]
- cOutputS3Region :: Lens' Command (Maybe Text)
- cTargets :: Lens' Command [Target]
- cCommandId :: Lens' Command (Maybe Text)
- cParameters :: Lens' Command (HashMap Text [Text])
- cComment :: Lens' Command (Maybe Text)
- cCompletedCount :: Lens' Command (Maybe Int)
- cOutputS3BucketName :: Lens' Command (Maybe Text)
- cMaxConcurrency :: 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)
- ciStandardErrorURL :: Lens' CommandInvocation (Maybe Text)
- ciStatusDetails :: Lens' CommandInvocation (Maybe Text)
- ciStandardOutputURL :: Lens' CommandInvocation (Maybe Text)
- ciCommandId :: Lens' CommandInvocation (Maybe Text)
- ciComment :: Lens' CommandInvocation (Maybe Text)
- ciTraceOutput :: Lens' CommandInvocation (Maybe Text)
- ciInstanceName :: 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)
- cpStandardErrorURL :: Lens' CommandPlugin (Maybe Text)
- cpResponseCode :: Lens' CommandPlugin (Maybe Int)
- cpStatusDetails :: Lens' CommandPlugin (Maybe Text)
- cpOutput :: Lens' CommandPlugin (Maybe Text)
- cpStandardOutputURL :: Lens' CommandPlugin (Maybe Text)
- cpName :: Lens' CommandPlugin (Maybe Text)
- cpOutputS3Region :: Lens' CommandPlugin (Maybe Text)
- cpOutputS3BucketName :: Lens' CommandPlugin (Maybe Text)
- cpResponseFinishDateTime :: Lens' CommandPlugin (Maybe UTCTime)
- data CreateAssociationBatchRequestEntry
- createAssociationBatchRequestEntry :: Text -> CreateAssociationBatchRequestEntry
- cabreInstanceId :: Lens' CreateAssociationBatchRequestEntry (Maybe Text)
- cabreScheduleExpression :: Lens' CreateAssociationBatchRequestEntry (Maybe Text)
- cabreOutputLocation :: Lens' CreateAssociationBatchRequestEntry (Maybe InstanceAssociationOutputLocation)
- cabreTargets :: Lens' CreateAssociationBatchRequestEntry [Target]
- cabreParameters :: Lens' CreateAssociationBatchRequestEntry (HashMap Text [Text])
- cabreDocumentVersion :: Lens' CreateAssociationBatchRequestEntry (Maybe Text)
- cabreName :: Lens' CreateAssociationBatchRequestEntry Text
- data DescribeActivationsFilter
- describeActivationsFilter :: DescribeActivationsFilter
- dafFilterKey :: Lens' DescribeActivationsFilter (Maybe DescribeActivationsFilterKeys)
- dafFilterValues :: Lens' DescribeActivationsFilter [Text]
- data DocumentDefaultVersionDescription
- documentDefaultVersionDescription :: DocumentDefaultVersionDescription
- ddvdDefaultVersion :: Lens' DocumentDefaultVersionDescription (Maybe Text)
- ddvdName :: Lens' DocumentDefaultVersionDescription (Maybe Text)
- data DocumentDescription
- documentDescription :: DocumentDescription
- dStatus :: Lens' DocumentDescription (Maybe DocumentStatus)
- dDocumentType :: Lens' DocumentDescription (Maybe DocumentType)
- dHash :: Lens' DocumentDescription (Maybe Text)
- dSchemaVersion :: Lens' DocumentDescription (Maybe Text)
- dSha1 :: Lens' DocumentDescription (Maybe Text)
- dDefaultVersion :: 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]
- dDocumentVersion :: Lens' DocumentDescription (Maybe Text)
- dDescription :: Lens' DocumentDescription (Maybe Text)
- dLatestVersion :: Lens' DocumentDescription (Maybe Text)
- data DocumentFilter
- documentFilter :: DocumentFilterKey -> Text -> DocumentFilter
- dfKey :: Lens' DocumentFilter DocumentFilterKey
- dfValue :: Lens' DocumentFilter Text
- data DocumentIdentifier
- documentIdentifier :: DocumentIdentifier
- diDocumentType :: Lens' DocumentIdentifier (Maybe DocumentType)
- diSchemaVersion :: Lens' DocumentIdentifier (Maybe Text)
- diOwner :: Lens' DocumentIdentifier (Maybe Text)
- diPlatformTypes :: Lens' DocumentIdentifier [PlatformType]
- diName :: Lens' DocumentIdentifier (Maybe Text)
- diDocumentVersion :: 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 DocumentVersionInfo
- documentVersionInfo :: DocumentVersionInfo
- dviCreatedDate :: Lens' DocumentVersionInfo (Maybe UTCTime)
- dviName :: Lens' DocumentVersionInfo (Maybe Text)
- dviDocumentVersion :: Lens' DocumentVersionInfo (Maybe Text)
- dviIsDefaultVersion :: Lens' DocumentVersionInfo (Maybe Bool)
- data FailedCreateAssociation
- failedCreateAssociation :: FailedCreateAssociation
- fcaEntry :: Lens' FailedCreateAssociation (Maybe CreateAssociationBatchRequestEntry)
- fcaFault :: Lens' FailedCreateAssociation (Maybe Fault)
- fcaMessage :: Lens' FailedCreateAssociation (Maybe Text)
- data InstanceAggregatedAssociationOverview
- instanceAggregatedAssociationOverview :: InstanceAggregatedAssociationOverview
- iaaoDetailedStatus :: Lens' InstanceAggregatedAssociationOverview (Maybe Text)
- iaaoInstanceAssociationStatusAggregatedCount :: Lens' InstanceAggregatedAssociationOverview (HashMap Text Int)
- data InstanceAssociation
- instanceAssociation :: InstanceAssociation
- iaAssociationId :: Lens' InstanceAssociation (Maybe Text)
- iaInstanceId :: Lens' InstanceAssociation (Maybe Text)
- iaContent :: Lens' InstanceAssociation (Maybe Text)
- data InstanceAssociationOutputLocation
- instanceAssociationOutputLocation :: InstanceAssociationOutputLocation
- iaolS3Location :: Lens' InstanceAssociationOutputLocation (Maybe S3OutputLocation)
- data InstanceAssociationOutputURL
- instanceAssociationOutputURL :: InstanceAssociationOutputURL
- iaouS3OutputURL :: Lens' InstanceAssociationOutputURL (Maybe S3OutputURL)
- data InstanceAssociationStatusInfo
- instanceAssociationStatusInfo :: InstanceAssociationStatusInfo
- iasiAssociationId :: Lens' InstanceAssociationStatusInfo (Maybe Text)
- iasiInstanceId :: Lens' InstanceAssociationStatusInfo (Maybe Text)
- iasiDetailedStatus :: Lens' InstanceAssociationStatusInfo (Maybe Text)
- iasiStatus :: Lens' InstanceAssociationStatusInfo (Maybe Text)
- iasiOutputURL :: Lens' InstanceAssociationStatusInfo (Maybe InstanceAssociationOutputURL)
- iasiExecutionSummary :: Lens' InstanceAssociationStatusInfo (Maybe Text)
- iasiName :: Lens' InstanceAssociationStatusInfo (Maybe Text)
- iasiErrorCode :: Lens' InstanceAssociationStatusInfo (Maybe Text)
- iasiDocumentVersion :: Lens' InstanceAssociationStatusInfo (Maybe Text)
- iasiExecutionDate :: Lens' InstanceAssociationStatusInfo (Maybe UTCTime)
- 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)
- iiLastSuccessfulAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime)
- iiActivationId :: Lens' InstanceInformation (Maybe Text)
- iiName :: Lens' InstanceInformation (Maybe Text)
- iiPlatformType :: Lens' InstanceInformation (Maybe PlatformType)
- iiAssociationOverview :: Lens' InstanceInformation (Maybe InstanceAggregatedAssociationOverview)
- iiAssociationStatus :: Lens' InstanceInformation (Maybe Text)
- iiLastAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime)
- 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 InstanceInformationStringFilter
- instanceInformationStringFilter :: Text -> NonEmpty Text -> InstanceInformationStringFilter
- iisfKey :: Lens' InstanceInformationStringFilter Text
- iisfValues :: Lens' InstanceInformationStringFilter (NonEmpty Text)
- data InventoryFilter
- inventoryFilter :: Text -> NonEmpty Text -> InventoryFilter
- ifType :: Lens' InventoryFilter (Maybe InventoryQueryOperatorType)
- ifKey :: Lens' InventoryFilter Text
- ifValues :: Lens' InventoryFilter (NonEmpty Text)
- data InventoryItem
- inventoryItem :: Text -> Text -> Text -> InventoryItem
- iiContentHash :: Lens' InventoryItem (Maybe Text)
- iiContent :: Lens' InventoryItem [HashMap Text Text]
- iiTypeName :: Lens' InventoryItem Text
- iiSchemaVersion :: Lens' InventoryItem Text
- iiCaptureTime :: Lens' InventoryItem Text
- data InventoryItemAttribute
- inventoryItemAttribute :: Text -> InventoryAttributeDataType -> InventoryItemAttribute
- iiaName :: Lens' InventoryItemAttribute Text
- iiaDataType :: Lens' InventoryItemAttribute InventoryAttributeDataType
- data InventoryItemSchema
- inventoryItemSchema :: Text -> NonEmpty InventoryItemAttribute -> InventoryItemSchema
- iisVersion :: Lens' InventoryItemSchema (Maybe Text)
- iisTypeName :: Lens' InventoryItemSchema Text
- iisAttributes :: Lens' InventoryItemSchema (NonEmpty InventoryItemAttribute)
- data InventoryResultEntity
- inventoryResultEntity :: InventoryResultEntity
- ireData :: Lens' InventoryResultEntity (HashMap Text InventoryResultItem)
- ireId :: Lens' InventoryResultEntity (Maybe Text)
- data InventoryResultItem
- inventoryResultItem :: Text -> Text -> InventoryResultItem
- iriContentHash :: Lens' InventoryResultItem (Maybe Text)
- iriCaptureTime :: Lens' InventoryResultItem (Maybe Text)
- iriTypeName :: Lens' InventoryResultItem Text
- iriSchemaVersion :: Lens' InventoryResultItem Text
- iriContent :: Lens' InventoryResultItem [HashMap Text Text]
- data LoggingInfo
- loggingInfo :: Text -> Text -> LoggingInfo
- liS3KeyPrefix :: Lens' LoggingInfo (Maybe Text)
- liS3BucketName :: Lens' LoggingInfo Text
- liS3Region :: Lens' LoggingInfo Text
- data MaintenanceWindowExecution
- maintenanceWindowExecution :: MaintenanceWindowExecution
- mweStatus :: Lens' MaintenanceWindowExecution (Maybe MaintenanceWindowExecutionStatus)
- mweStartTime :: Lens' MaintenanceWindowExecution (Maybe UTCTime)
- mweWindowExecutionId :: Lens' MaintenanceWindowExecution (Maybe Text)
- mweStatusDetails :: Lens' MaintenanceWindowExecution (Maybe Text)
- mweEndTime :: Lens' MaintenanceWindowExecution (Maybe UTCTime)
- mweWindowId :: Lens' MaintenanceWindowExecution (Maybe Text)
- data MaintenanceWindowExecutionTaskIdentity
- maintenanceWindowExecutionTaskIdentity :: MaintenanceWindowExecutionTaskIdentity
- mwetiStatus :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe MaintenanceWindowExecutionStatus)
- mwetiTaskExecutionId :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text)
- mwetiStartTime :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe UTCTime)
- mwetiTaskType :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe MaintenanceWindowTaskType)
- mwetiTaskARN :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text)
- mwetiWindowExecutionId :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text)
- mwetiStatusDetails :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text)
- mwetiEndTime :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe UTCTime)
- data MaintenanceWindowExecutionTaskInvocationIdentity
- maintenanceWindowExecutionTaskInvocationIdentity :: MaintenanceWindowExecutionTaskInvocationIdentity
- mwetiiStatus :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe MaintenanceWindowExecutionStatus)
- mwetiiExecutionId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text)
- mwetiiTaskExecutionId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text)
- mwetiiStartTime :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe UTCTime)
- mwetiiInvocationId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text)
- mwetiiOwnerInformation :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text)
- mwetiiWindowTargetId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text)
- mwetiiWindowExecutionId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text)
- mwetiiStatusDetails :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text)
- mwetiiEndTime :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe UTCTime)
- mwetiiParameters :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text)
- data MaintenanceWindowFilter
- maintenanceWindowFilter :: MaintenanceWindowFilter
- mwfValues :: Lens' MaintenanceWindowFilter [Text]
- mwfKey :: Lens' MaintenanceWindowFilter (Maybe Text)
- data MaintenanceWindowIdentity
- maintenanceWindowIdentity :: MaintenanceWindowIdentity
- mwiEnabled :: Lens' MaintenanceWindowIdentity (Maybe Bool)
- mwiName :: Lens' MaintenanceWindowIdentity (Maybe Text)
- mwiCutoff :: Lens' MaintenanceWindowIdentity (Maybe Natural)
- mwiDuration :: Lens' MaintenanceWindowIdentity (Maybe Natural)
- mwiWindowId :: Lens' MaintenanceWindowIdentity (Maybe Text)
- data MaintenanceWindowTarget
- maintenanceWindowTarget :: MaintenanceWindowTarget
- mResourceType :: Lens' MaintenanceWindowTarget (Maybe MaintenanceWindowResourceType)
- mOwnerInformation :: Lens' MaintenanceWindowTarget (Maybe Text)
- mWindowTargetId :: Lens' MaintenanceWindowTarget (Maybe Text)
- mTargets :: Lens' MaintenanceWindowTarget [Target]
- mWindowId :: Lens' MaintenanceWindowTarget (Maybe Text)
- data MaintenanceWindowTask
- maintenanceWindowTask :: MaintenanceWindowTask
- mwtServiceRoleARN :: Lens' MaintenanceWindowTask (Maybe Text)
- mwtWindowTaskId :: Lens' MaintenanceWindowTask (Maybe Text)
- mwtTaskParameters :: Lens' MaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression))
- mwtPriority :: Lens' MaintenanceWindowTask (Maybe Natural)
- mwtTaskARN :: Lens' MaintenanceWindowTask (Maybe Text)
- mwtMaxErrors :: Lens' MaintenanceWindowTask (Maybe Text)
- mwtTargets :: Lens' MaintenanceWindowTask [Target]
- mwtLoggingInfo :: Lens' MaintenanceWindowTask (Maybe LoggingInfo)
- mwtType :: Lens' MaintenanceWindowTask (Maybe MaintenanceWindowTaskType)
- mwtMaxConcurrency :: Lens' MaintenanceWindowTask (Maybe Text)
- mwtWindowId :: Lens' MaintenanceWindowTask (Maybe Text)
- data MaintenanceWindowTaskParameterValueExpression
- maintenanceWindowTaskParameterValueExpression :: MaintenanceWindowTaskParameterValueExpression
- mwtpveValues :: Lens' MaintenanceWindowTaskParameterValueExpression (Maybe [Text])
- data NotificationConfig
- notificationConfig :: NotificationConfig
- ncNotificationEvents :: Lens' NotificationConfig [NotificationEvent]
- ncNotificationType :: Lens' NotificationConfig (Maybe NotificationType)
- ncNotificationARN :: Lens' NotificationConfig (Maybe Text)
- data Parameter
- parameter :: Parameter
- pValue :: Lens' Parameter (Maybe Text)
- pName :: Lens' Parameter (Maybe Text)
- pType :: Lens' Parameter (Maybe ParameterType)
- data ParameterHistory
- parameterHistory :: ParameterHistory
- phLastModifiedDate :: Lens' ParameterHistory (Maybe UTCTime)
- phKeyId :: Lens' ParameterHistory (Maybe Text)
- phValue :: Lens' ParameterHistory (Maybe Text)
- phName :: Lens' ParameterHistory (Maybe Text)
- phLastModifiedUser :: Lens' ParameterHistory (Maybe Text)
- phType :: Lens' ParameterHistory (Maybe ParameterType)
- phDescription :: Lens' ParameterHistory (Maybe Text)
- data ParameterMetadata
- parameterMetadata :: ParameterMetadata
- pmLastModifiedDate :: Lens' ParameterMetadata (Maybe UTCTime)
- pmKeyId :: Lens' ParameterMetadata (Maybe Text)
- pmName :: Lens' ParameterMetadata (Maybe Text)
- pmLastModifiedUser :: Lens' ParameterMetadata (Maybe Text)
- pmType :: Lens' ParameterMetadata (Maybe ParameterType)
- pmDescription :: Lens' ParameterMetadata (Maybe Text)
- data ParametersFilter
- parametersFilter :: NonEmpty Text -> ParametersFilter
- pfKey :: Lens' ParametersFilter (Maybe ParametersFilterKey)
- pfValues :: Lens' ParametersFilter (NonEmpty Text)
- data ResultAttribute
- resultAttribute :: Text -> ResultAttribute
- raTypeName :: Lens' ResultAttribute Text
- data S3OutputLocation
- s3OutputLocation :: S3OutputLocation
- solOutputS3KeyPrefix :: Lens' S3OutputLocation (Maybe Text)
- solOutputS3Region :: Lens' S3OutputLocation (Maybe Text)
- solOutputS3BucketName :: Lens' S3OutputLocation (Maybe Text)
- data S3OutputURL
- s3OutputURL :: S3OutputURL
- souOutputURL :: Lens' S3OutputURL (Maybe Text)
- data StepExecution
- stepExecution :: StepExecution
- seInputs :: Lens' StepExecution (HashMap Text Text)
- seStepName :: Lens' StepExecution (Maybe Text)
- seExecutionEndTime :: Lens' StepExecution (Maybe UTCTime)
- seFailureMessage :: Lens' StepExecution (Maybe Text)
- seResponse :: Lens' StepExecution (Maybe Text)
- seAction :: Lens' StepExecution (Maybe Text)
- seResponseCode :: Lens' StepExecution (Maybe Text)
- seStepStatus :: Lens' StepExecution (Maybe AutomationExecutionStatus)
- seOutputs :: Lens' StepExecution (HashMap Text [Text])
- seExecutionStartTime :: Lens' StepExecution (Maybe UTCTime)
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
- data Target
- target :: Target
- tValues :: Lens' Target [Text]
- tKey :: Lens' Target (Maybe Text)
Service Configuration
API version 2014-11-06
of the Amazon Simple Systems Manager (SSM) SDK configuration.
Errors
_AutomationDefinitionVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An Automation document with the specified name and version could not be found.
_InvalidDocumentVersion :: AsError a => Getting (First ServiceError) a ServiceError Source #
The document version is not valid or does not exist.
_InvalidSchedule :: AsError a => Getting (First ServiceError) a ServiceError Source #
The schedule is invalid. Verify your cron or rate expression and try again.
_UnsupportedParameterType :: AsError a => Getting (First ServiceError) a ServiceError Source #
The parameter type is not supported.
_InvalidPluginName :: AsError a => Getting (First ServiceError) a ServiceError Source #
The plugin name is not valid.
_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.
_InvalidFilterValue :: AsError a => Getting (First ServiceError) a ServiceError Source #
The filter value is not valid. Verify the value and try again.
_InvalidItemContentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more content items is not valid.
_InvalidPermissionType :: AsError a => Getting (First ServiceError) a ServiceError Source #
The permission type is not supported. Share is the only supported permission type.
_AssociatedInstances :: AsError a => Getting (First ServiceError) a ServiceError Source #
You must disassociate an SSM document from all instances before you can delete it.
_InvalidInstanceId :: AsError a => Getting (First ServiceError) a ServiceError Source #
The following problems can cause this exception:
You do not have permission to access the instance.
The SSM agent is not running. On managed instances and Linux instances, verify that the SSM agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
_StatusUnchanged :: AsError a => Getting (First ServiceError) a ServiceError Source #
The updated status is the same as the current status.
_InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified token is not valid.
_InvalidOutputFolder :: AsError a => Getting (First ServiceError) a ServiceError Source #
The S3 bucket does not exist.
_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.
_InvalidResultAttributeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified inventory item result attribute is not valid.
_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance Windows have been created).
_InvalidCommandId :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for InvalidCommandId' errors.
_DuplicateInstanceId :: AsError a => Getting (First ServiceError) a ServiceError Source #
You cannot specify an instance ID in more than one association.
_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.
_UnsupportedInventorySchemaVersionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema
to see the available schema version for each type.
_InvalidDocument :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified document does not exist.
_AutomationDefinitionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An Automation document with the specified name could not be found.
_InvalidFilterKey :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified key is not valid.
_InvalidAutomationExecutionParametersException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The supplied parameters for invoking the specified Automation document are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
_AutomationExecutionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is no automation execution information for the requested automation execution ID.
_InvalidTypeNameException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The parameter type name is not valid.
_ItemSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The inventory item size has exceeded the size limit.
_DoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn’t exist.
_AutomationExecutionLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of simultaneously running Automation executions exceeded the allowable limit.
_IdempotentParameterMismatch :: AsError a => Getting (First ServiceError) a ServiceError Source #
Error returned when an idempotent operation is retried and the parameters don’t match the original call to the API with the same idempotency token.
_InvalidInstanceInformationFilterValue :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified filter value is not valid.
_ItemContentMismatchException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The inventory item has invalid content.
_ParameterAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The parameter already exists. You can't create duplicate parameters.
_AssociationAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified association already exists.
_InvalidDocumentContent :: AsError a => Getting (First ServiceError) a ServiceError Source #
The content for the SSM document is not valid.
_ParameterLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try again.
_AssociationLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can have at most 2,000 active associations.
_AssociationDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified association does not exist.
_ParameterNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The parameter could not be found. Verify the name and try again.
_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred on the server side.
_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 Run Command notifications, see Getting Amazon SNS Notifications When a Command Changes Status in the Amazon Elastic Compute Cloud User Guide .
_TooManyUpdates :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are concurrent updates for a resource that supports one update at a time.
_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.
_InvalidDocumentSchemaVersion :: AsError a => Getting (First ServiceError) a ServiceError Source #
The version of the document schema is not supported.
_MaxDocumentSizeExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The size limit of an SSM document is 64 KB.
_InvalidUpdate :: AsError a => Getting (First ServiceError) a ServiceError Source #
The update is not valid.
_CustomSchemaCountLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.
_InvalidTarget :: AsError a => Getting (First ServiceError) a ServiceError Source #
The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.
_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.
_InvocationDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError Source #
The command ID and instance ID you specified did not match any invocations. Verify the command ID adn the instance ID and try again.
_DocumentVersionLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The document has too many versions. Delete one or more document versions and try again.
_InvalidOutputLocation :: AsError a => Getting (First ServiceError) a ServiceError Source #
The output location is not valid or does not exist.
_InvalidKeyId :: AsError a => Getting (First ServiceError) a ServiceError Source #
The query key ID is not valid.
_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 :: 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 :: 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.
_TotalSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The size of inventory data has exceeded the total size limit for the resource.
_TooManyTagsError :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Targets
parameter includes too many tags. Remove one or more tags and try the command again.
_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.
_DuplicateDocumentContent :: AsError a => Getting (First ServiceError) a ServiceError Source #
The content of the association document matches another document. Change the content of the document and try again.
_DocumentAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified SSM document already exists.
_DocumentLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can have at most 200 active SSM documents.
_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.
AssociationFilterKey
data AssociationFilterKey Source #
AFKAssociationId | |
AFKAssociationStatusName | |
AFKInstanceId | |
AFKLastExecutedAfter | |
AFKLastExecutedBefore | |
AFKName |
AssociationStatusName
data AssociationStatusName Source #
AutomationExecutionFilterKey
data AutomationExecutionFilterKey Source #
AutomationExecutionStatus
data AutomationExecutionStatus 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 #
DocumentType
data DocumentType Source #
Fault
InstanceInformationFilterKey
data InstanceInformationFilterKey Source #
IIFKActivationIds | |
IIFKAgentVersion | |
IIFKAssociationStatus | |
IIFKIAMRole | |
IIFKInstanceIds | |
IIFKPingStatus | |
IIFKPlatformTypes | |
IIFKResourceType |
InventoryAttributeDataType
data InventoryAttributeDataType Source #
InventoryQueryOperatorType
data InventoryQueryOperatorType Source #
MaintenanceWindowExecutionStatus
data MaintenanceWindowExecutionStatus Source #
MWESCancelled | |
MWESCancelling | |
MWESFailed | |
MWESInProgress | |
MWESPending | |
MWESSkippedOverlapping | |
MWESSuccess | |
MWESTimedOut |
MaintenanceWindowResourceType
data MaintenanceWindowResourceType Source #
MaintenanceWindowTaskType
data MaintenanceWindowTaskType Source #
NotificationEvent
data NotificationEvent Source #
NotificationType
data NotificationType Source #
ParameterType
data ParameterType Source #
ParametersFilterKey
data ParametersFilterKey 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:
aExpired
- Whether or not the activation is expired.aDefaultInstanceName
- A name for the managed instance when it is created.aActivationId
- The ID created by Systems Manager when you submitted the activation.aCreatedDate
- The date the activation was created.aRegistrationLimit
- The maximum number of managed instances that can be registered using this activation.aExpirationDate
- The date when this activation can no longer be used to register managed instances.aDescription
- A user defined description of the activation.aRegistrationsCount
- The number of managed instances already registered with this activation.aIAMRole
- The Amazon Identity and Access Management (IAM) role to assign to the managed instance.
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 Systems Manager 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:
aAssociationId
- 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.aInstanceId
- The ID of the instance.aOverview
- Information about the association.aLastExecutionDate
- The date on which the association was last run.aScheduleExpression
- A cron expression that specifies a schedule when the association runs.aName
- The name of the SSM document.aTargets
- The instances targeted by the request to create an association.aDocumentVersion
- The version of the document used in the association.
aAssociationId :: 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.
aInstanceId :: Lens' Association (Maybe Text) Source #
The ID of the instance.
aOverview :: Lens' Association (Maybe AssociationOverview) Source #
Information about the association.
aLastExecutionDate :: Lens' Association (Maybe UTCTime) Source #
The date on which the association was last run.
aScheduleExpression :: Lens' Association (Maybe Text) Source #
A cron expression that specifies a schedule when the association runs.
aTargets :: Lens' Association [Target] Source #
The instances targeted by the request to create an association.
aDocumentVersion :: Lens' Association (Maybe Text) Source #
The version of the document used in the association.
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:
adAssociationId
- The association ID.adInstanceId
- The ID of the instance.adStatus
- The association status.adLastSuccessfulExecutionDate
- The last date on which the association was successfully run.adOverview
- Information about the association.adLastUpdateAssociationDate
- The date when the association was last updated.adDate
- The date when the association was made.adLastExecutionDate
- The date on which the association was last run.adScheduleExpression
- A cron expression that specifies a schedule when the association runs.adName
- The name of the SSM document.adOutputLocation
- An Amazon S3 bucket where you want to store the output details of the request.adTargets
- The instances targeted by the request.adParameters
- A description of the parameters for a document.adDocumentVersion
- The document version.
adAssociationId :: Lens' AssociationDescription (Maybe Text) Source #
The association ID.
adInstanceId :: Lens' AssociationDescription (Maybe Text) Source #
The ID of the instance.
adStatus :: Lens' AssociationDescription (Maybe AssociationStatus) Source #
The association status.
adLastSuccessfulExecutionDate :: Lens' AssociationDescription (Maybe UTCTime) Source #
The last date on which the association was successfully run.
adOverview :: Lens' AssociationDescription (Maybe AssociationOverview) Source #
Information about the association.
adLastUpdateAssociationDate :: Lens' AssociationDescription (Maybe UTCTime) Source #
The date when the association was last updated.
adDate :: Lens' AssociationDescription (Maybe UTCTime) Source #
The date when the association was made.
adLastExecutionDate :: Lens' AssociationDescription (Maybe UTCTime) Source #
The date on which the association was last run.
adScheduleExpression :: Lens' AssociationDescription (Maybe Text) Source #
A cron expression that specifies a schedule when the association runs.
adOutputLocation :: Lens' AssociationDescription (Maybe InstanceAssociationOutputLocation) Source #
An Amazon S3 bucket where you want to store the output details of the request.
adParameters :: Lens' AssociationDescription (HashMap Text [Text]) Source #
A description of the parameters for a document.
adDocumentVersion :: Lens' AssociationDescription (Maybe Text) Source #
The document version.
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.
AssociationOverview
data AssociationOverview Source #
Information about the association.
See: associationOverview
smart constructor.
associationOverview :: AssociationOverview Source #
Creates a value of AssociationOverview
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aoDetailedStatus
- A detailed status of the association.aoStatus
- The status of the association. Status can be:Pending
,Success
, orFailed
.aoAssociationStatusAggregatedCount
- Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.
aoDetailedStatus :: Lens' AssociationOverview (Maybe Text) Source #
A detailed status of the association.
aoStatus :: Lens' AssociationOverview (Maybe Text) Source #
The status of the association. Status can be: Pending
, Success
, or Failed
.
aoAssociationStatusAggregatedCount :: Lens' AssociationOverview (HashMap Text Int) Source #
Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.
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
- A user-defined string.asDate
- The date when the status changed.asName
- The status.asMessage
- The reason for the status.
asAdditionalInfo :: Lens' AssociationStatus (Maybe Text) Source #
A user-defined string.
asName :: Lens' AssociationStatus AssociationStatusName Source #
The status.
AutomationExecution
data AutomationExecution Source #
Detailed information about the current state of an individual Automation execution.
See: automationExecution
smart constructor.
automationExecution :: AutomationExecution Source #
Creates a value of AutomationExecution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aeDocumentName
- The name of the Automation document used during the execution.aeExecutionEndTime
- The time the execution finished.aeFailureMessage
- A message describing why an execution has failed, if the status is set to Failed.aeAutomationExecutionStatus
- The execution status of the Automation.aeOutputs
- The list of execution outputs as defined in the automation document.aeExecutionStartTime
- The time the execution started.aeParameters
- The key-value map of execution parameters, which were supplied when callingStartAutomationExecution
.aeDocumentVersion
- The version of the document to use during execution.aeAutomationExecutionId
- The execution ID.aeStepExecutions
- A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.
aeDocumentName :: Lens' AutomationExecution (Maybe Text) Source #
The name of the Automation document used during the execution.
aeExecutionEndTime :: Lens' AutomationExecution (Maybe UTCTime) Source #
The time the execution finished.
aeFailureMessage :: Lens' AutomationExecution (Maybe Text) Source #
A message describing why an execution has failed, if the status is set to Failed.
aeAutomationExecutionStatus :: Lens' AutomationExecution (Maybe AutomationExecutionStatus) Source #
The execution status of the Automation.
aeOutputs :: Lens' AutomationExecution (HashMap Text [Text]) Source #
The list of execution outputs as defined in the automation document.
aeExecutionStartTime :: Lens' AutomationExecution (Maybe UTCTime) Source #
The time the execution started.
aeParameters :: Lens' AutomationExecution (HashMap Text [Text]) Source #
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution
.
aeDocumentVersion :: Lens' AutomationExecution (Maybe Text) Source #
The version of the document to use during execution.
aeAutomationExecutionId :: Lens' AutomationExecution (Maybe Text) Source #
The execution ID.
aeStepExecutions :: Lens' AutomationExecution [StepExecution] Source #
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.
AutomationExecutionFilter
data AutomationExecutionFilter Source #
A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.
See: automationExecutionFilter
smart constructor.
automationExecutionFilter Source #
Creates a value of AutomationExecutionFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aefKey :: Lens' AutomationExecutionFilter AutomationExecutionFilterKey Source #
The aspect of the Automation execution information that should be limited.
aefValues :: Lens' AutomationExecutionFilter (NonEmpty Text) Source #
The values used to limit the execution information associated with the filter's key.
AutomationExecutionMetadata
data AutomationExecutionMetadata Source #
Details about a specific Automation execution.
See: automationExecutionMetadata
smart constructor.
automationExecutionMetadata :: AutomationExecutionMetadata Source #
Creates a value of AutomationExecutionMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aemLogFile
- An Amazon S3 bucket where execution information is stored.aemExecutedBy
- The IAM role ARN of the user who executed the Automation.aemDocumentName
- The name of the Automation document used during execution.aemExecutionEndTime
- The time the execution finished. This is not populated if the execution is still in progress.aemAutomationExecutionStatus
- The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.aemOutputs
- The list of execution outputs as defined in the Automation document.aemExecutionStartTime
- The time the execution started.>aemDocumentVersion
- The document version used during the execution.aemAutomationExecutionId
- The execution ID.
aemLogFile :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
An Amazon S3 bucket where execution information is stored.
aemExecutedBy :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The IAM role ARN of the user who executed the Automation.
aemDocumentName :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The name of the Automation document used during execution.
aemExecutionEndTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime) Source #
The time the execution finished. This is not populated if the execution is still in progress.
aemAutomationExecutionStatus :: Lens' AutomationExecutionMetadata (Maybe AutomationExecutionStatus) Source #
The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
aemOutputs :: Lens' AutomationExecutionMetadata (HashMap Text [Text]) Source #
The list of execution outputs as defined in the Automation document.
aemExecutionStartTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime) Source #
The time the execution started.>
aemDocumentVersion :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The document version used during the execution.
aemAutomationExecutionId :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The execution ID.
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:
cStatus
- The status of the command.cExpiresAfter
- 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
- Configurations for sending notifications about command status changes.cTargetCount
- The number of targets for the command.cOutputS3KeyPrefix
- 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
- The name of the SSM document requested for execution.cErrorCount
- The number of targets for which the status isFailed
orExecution Timed Out
.cStatusDetails
- A detailed status of the command execution.StatusDetails
includes more information thanStatus
because it includes states resulting from error and concurrency control parameters.StatusDetails
can show different results thanStatus
. For more information about these statuses, see Monitor Commands (Linux) or Monitor Commands (Windows).StatusDetails
can be one of the following values: * Pending – The command has not been sent to any instances. * In Progress – The command has been sent to at least one instance but has not reached a final state on all instances. * Success – The command successfully executed on all invocations. This is a terminal state. * Delivery Timed Out – The value ofMaxErrors
or more command invocations shows a status ofDelivery Timed Out
. This is a terminal state. * Execution Timed Out – The value ofMaxErrors
or more command invocations shows a status ofExecution Timed Out
. This is a terminal state. * Failed – The value ofMaxErrors
or more command invocations shows a status ofFailed
. This is a terminal state. * Incomplete – The command was attempted on all instances and one or more invocations does not have a value ofSuccess
but not enough invocations failed for the status to beFailed
. This is a terminal state. * Canceled – The command was terminated before it was completed. This is a terminal state. * Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.cMaxErrors
- 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 50. For more information about how to useMaxErrors
, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).cInstanceIds
- The instance IDs against which this command was requested.cOutputS3Region
- The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.cTargets
- An array of search criteria that targets instances using aKey
;Value
combination that you specify.Targets
is required if you don't provide one or more instance IDs in the call.cCommandId
- A unique identifier for this command.cParameters
- The parameter values to be inserted in the SSM document when executing the command.cComment
- User-specified information about the command, such as a brief description of what the command should do.cCompletedCount
- 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
,Canceled
,Terminated
, orUndeliverable
.cOutputS3BucketName
- The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.cMaxConcurrency
- The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to useMaxConcurrency
, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).cRequestedDateTime
- The date and time the command was requested.cServiceRole
- The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
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.
cErrorCount :: Lens' Command (Maybe Int) Source #
The number of targets for which the status is Failed
or Execution Timed Out
.
cStatusDetails :: 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 Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails
can be one of the following values: * Pending – The command has not been sent to any instances. * In Progress – The command has been sent to at least one instance but has not reached a final state on all instances. * Success – The command successfully executed 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 instances and one or more invocations does not have a value of Success
but not enough invocations failed for the status to be Failed
. This is a terminal state. * Canceled – The command was terminated before it was completed. This is a terminal state. * Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.
cMaxErrors :: 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 50. For more information about how to use MaxErrors
, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
cInstanceIds :: Lens' Command [Text] Source #
The instance IDs against which this command was requested.
cOutputS3Region :: Lens' Command (Maybe Text) Source #
The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
cTargets :: Lens' Command [Target] Source #
An array of search criteria that targets instances using a Key
;Value
combination that you specify. Targets
is required if you don't provide one or more instance IDs in the call.
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.
cCompletedCount :: 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
, Canceled
, Terminated
, or Undeliverable
.
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.
cMaxConcurrency :: Lens' Command (Maybe Text) Source #
The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency
, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
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 Run Command 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
- The instance ID in which this invocation was requested.ciStatus
- Whether or not the invocation succeeded, failed, or is pending.ciNotificationConfig
- Configurations for sending notifications about command status changes on a per instance basis.ciCommandPlugins
- Undocumented member.ciDocumentName
- The document name that was requested for execution.ciStandardErrorURL
- The URL to the plugin’s StdErr file in Amazon S3, if the Amazon 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 Amazon S3 bucket was defined for the command.ciStatusDetails
- A detailed status of the command execution for each invocation (each instance targeted by the command).StatusDetails
includes more information thanStatus
because it includes states resulting from error and concurrency control parameters.StatusDetails
can show different results thanStatus
. For more information about these statuses, see Monitor Commands (Linux) or Monitor Commands (Windows).StatusDetails
can be one of the following values: * Pending – The command has not been sent to the instance. * In Progress – The command has been sent to the instance but has not 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 was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command’sMaxErrors
limit, but they do contribute to whether the parent command status isSuccess
orIncomplete
. This is a terminal state. * Execution Timed Out – Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against theMaxErrors
limit of the parent command. This is a terminal state. * Failed – The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against theMaxErrors
limit of the parent command. This is a terminal state. * Canceled – The command was terminated before it was completed. This is a terminal state. * Undeliverable – The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command’sMaxErrors
limit and don't contribute to whether the parent command status isSuccess
orIncomplete
. This is a terminal state. * Terminated – The parent command exceeded itsMaxErrors
limit and subsequent command invocations were canceled by the system. This is a terminal state.ciStandardOutputURL
- The URL to the plugin’s StdOut file in Amazon S3, if the Amazon 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 Amazon S3 bucket was defined for the command.ciCommandId
- The command against which this invocation was requested.ciComment
- User-specified information about the command, such as a brief description of what the command should do.ciTraceOutput
- Gets the trace output sent by the agent.ciInstanceName
- The name of the invocation target. For Amazon EC2 instances this is the value for theaws:Name
tag. For on-premises instances, this is the name of the instance.ciRequestedDateTime
- The time and date the request was sent to this instance.ciServiceRole
- The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.
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.
ciStandardErrorURL :: Lens' CommandInvocation (Maybe Text) Source #
The URL to the plugin’s StdErr file in Amazon S3, if the Amazon 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 Amazon S3 bucket was defined for the command.
ciStatusDetails :: Lens' CommandInvocation (Maybe Text) Source #
A detailed status of the command execution for each invocation (each instance 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 Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails
can be one of the following values: * Pending – The command has not been sent to the instance. * In Progress – The command has been sent to the instance but has not 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 was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not 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 instance, but the execution was not 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 was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors
limit of the parent command. This is a terminal state. * Canceled – The command was terminated before it was completed. This is a terminal state. * Undeliverable – The command can't be delivered to the instance. The instance 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.
ciStandardOutputURL :: Lens' CommandInvocation (Maybe Text) Source #
The URL to the plugin’s StdOut file in Amazon S3, if the Amazon 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 Amazon S3 bucket was defined for the command.
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.
ciInstanceName :: Lens' CommandInvocation (Maybe Text) Source #
The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name
tag. For on-premises instances, this is the name of the instance.
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 Run Command 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
- The status of this plugin. You can execute a document with multiple plugins.cpResponseStartDateTime
- The time the plugin started executing.cpOutputS3KeyPrefix
- 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:test_folderab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fixi-1234567876543/awsrunShellScript
test_folder
is the name of the Amazon S3 bucket;ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;i-1234567876543
is the instance ID;awsrunShellScript
is the name of the plugin.cpStandardErrorURL
- The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.cpResponseCode
- A numeric response code generated after executing the plugin.cpStatusDetails
- A detailed status of the plugin execution.StatusDetails
includes more information thanStatus
because it includes states resulting from error and concurrency control parameters.StatusDetails
can show different results thanStatus
. For more information about these statuses, see Monitor Commands (Linux) or Monitor Commands (Windows).StatusDetails
can be one of the following values: * Pending – The command has not been sent to the instance. * In Progress – The command has been sent to the instance but has not 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 was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command’sMaxErrors
limit, but they do contribute to whether the parent command status isSuccess
orIncomplete
. This is a terminal state. * Execution Timed Out – Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against theMaxErrors
limit of the parent command. This is a terminal state. * Failed – The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against theMaxErrors
limit of the parent command. This is a terminal state. * Canceled – The command was terminated before it was completed. This is a terminal state. * Undeliverable – The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command’sMaxErrors
limit, and they don't contribute to whether the parent command status isSuccess
orIncomplete
. This is a terminal state. * Terminated – The parent command exceeded itsMaxErrors
limit and subsequent command invocations were canceled by the system. This is a terminal state.cpOutput
- Output of the plugin execution.cpStandardOutputURL
- The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.cpName
- 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.cpOutputS3Region
- The name of the region where the output is stored in Amazon S3.cpOutputS3BucketName
- 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:test_folderab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fixi-1234567876543/awsrunShellScript
test_folder
is the name of the Amazon S3 bucket;ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;i-1234567876543
is the instance ID;awsrunShellScript
is the name of the plugin.cpResponseFinishDateTime
- The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
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. For example, in the following response: test_folderab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fixi-1234567876543/awsrunShellScript
test_folder
is the name of the Amazon S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix; i-1234567876543
is the instance ID; awsrunShellScript
is the name of the plugin.
cpStandardErrorURL :: Lens' CommandPlugin (Maybe Text) Source #
The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.
cpResponseCode :: Lens' CommandPlugin (Maybe Int) Source #
A numeric response code generated after executing the plugin.
cpStatusDetails :: 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 Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails
can be one of the following values: * Pending – The command has not been sent to the instance. * In Progress – The command has been sent to the instance but has not 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 was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not 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 instance, but the execution was not 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 was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors
limit of the parent command. This is a terminal state. * Canceled – The command was terminated before it was completed. This is a terminal state. * Undeliverable – The command can't be delivered to the instance. The instance 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.
cpStandardOutputURL :: Lens' CommandPlugin (Maybe Text) Source #
The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.
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.
cpOutputS3Region :: Lens' CommandPlugin (Maybe Text) Source #
The name of the region where the output is stored in Amazon S3.
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. For example, in the following response: test_folderab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fixi-1234567876543/awsrunShellScript
test_folder
is the name of the Amazon S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix; i-1234567876543
is the instance ID; awsrunShellScript
is the name of the plugin.
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 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
- The ID of the instance.cabreScheduleExpression
- A cron expression that specifies a schedule when the association runs.cabreOutputLocation
- An Amazon S3 bucket where you want to store the results of this request.cabreTargets
- The instances targeted by the request.cabreParameters
- A description of the parameters for a document.cabreDocumentVersion
- The document version.cabreName
- The name of the configuration document.
cabreInstanceId :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #
The ID of the instance.
cabreScheduleExpression :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #
A cron expression that specifies a schedule when the association runs.
cabreOutputLocation :: Lens' CreateAssociationBatchRequestEntry (Maybe InstanceAssociationOutputLocation) Source #
An Amazon S3 bucket where you want to store the results of this request.
cabreTargets :: Lens' CreateAssociationBatchRequestEntry [Target] Source #
The instances targeted by the request.
cabreParameters :: Lens' CreateAssociationBatchRequestEntry (HashMap Text [Text]) Source #
A description of the parameters for a document.
cabreDocumentVersion :: Lens' CreateAssociationBatchRequestEntry (Maybe Text) Source #
The document version.
cabreName :: Lens' CreateAssociationBatchRequestEntry Text Source #
The name of the configuration 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
- The name of the filter.dafFilterValues
- The filter values.
dafFilterKey :: Lens' DescribeActivationsFilter (Maybe DescribeActivationsFilterKeys) Source #
The name of the filter.
dafFilterValues :: Lens' DescribeActivationsFilter [Text] Source #
The filter values.
DocumentDefaultVersionDescription
data DocumentDefaultVersionDescription Source #
A default version of a document.
See: documentDefaultVersionDescription
smart constructor.
documentDefaultVersionDescription :: DocumentDefaultVersionDescription Source #
Creates a value of DocumentDefaultVersionDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddvdDefaultVersion
- The default version of the document.ddvdName
- The name of the document.
ddvdDefaultVersion :: Lens' DocumentDefaultVersionDescription (Maybe Text) Source #
The default version of the document.
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
- The status of the SSM document.dDocumentType
- The type of document.dHash
- The Sha256 or Sha1 hash created by the system when the document was created.dSchemaVersion
- The schema version.dSha1
- The SHA1 hash of the document, which you can use for verification purposes.dDefaultVersion
- The default version.dOwner
- The AWS user account of the person who created the document.dPlatformTypes
- The list of OS platforms compatible with this SSM document.dCreatedDate
- The date when the SSM document was created.dName
- The name of the SSM document.dHashType
- Sha256 or Sha1.dParameters
- A description of the parameters for a document.dDocumentVersion
- The document version.dDescription
- A description of the document.dLatestVersion
- The latest version of the document.
dStatus :: Lens' DocumentDescription (Maybe DocumentStatus) Source #
The status of the SSM document.
dDocumentType :: Lens' DocumentDescription (Maybe DocumentType) Source #
The type of document.
dHash :: Lens' DocumentDescription (Maybe Text) Source #
The Sha256 or Sha1 hash created by the system when the document was created.
dSchemaVersion :: Lens' DocumentDescription (Maybe Text) Source #
The schema version.
dSha1 :: Lens' DocumentDescription (Maybe Text) Source #
The SHA1 hash of the document, which you can use for verification purposes.
dDefaultVersion :: Lens' DocumentDescription (Maybe Text) Source #
The default version.
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.
dParameters :: Lens' DocumentDescription [DocumentParameter] Source #
A description of the parameters for a document.
dDocumentVersion :: Lens' DocumentDescription (Maybe Text) Source #
The document version.
dDescription :: Lens' DocumentDescription (Maybe Text) Source #
A description of the document.
dLatestVersion :: Lens' DocumentDescription (Maybe Text) Source #
The latest version 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:
diDocumentType
- The document type.diSchemaVersion
- The schema version.diOwner
- The AWS user account of the person who created the document.diPlatformTypes
- The operating system platform.diName
- The name of the SSM document.diDocumentVersion
- The document version.
diDocumentType :: Lens' DocumentIdentifier (Maybe DocumentType) Source #
The document type.
diSchemaVersion :: Lens' DocumentIdentifier (Maybe Text) Source #
The schema version.
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.
diDocumentVersion :: Lens' DocumentIdentifier (Maybe Text) Source #
The document version.
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:
dpName
- The name of the parameter.dpDefaultValue
- If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.dpType
- The type of parameter. The type can be either “String” or “StringList”.dpDescription
- A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
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.
DocumentVersionInfo
data DocumentVersionInfo Source #
Version information about the document.
See: documentVersionInfo
smart constructor.
documentVersionInfo :: DocumentVersionInfo Source #
Creates a value of DocumentVersionInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dviCreatedDate
- The date the document was created.dviName
- The document name.dviDocumentVersion
- The document version.dviIsDefaultVersion
- An identifier for the default version of the document.
dviCreatedDate :: Lens' DocumentVersionInfo (Maybe UTCTime) Source #
The date the document was created.
dviDocumentVersion :: Lens' DocumentVersionInfo (Maybe Text) Source #
The document version.
dviIsDefaultVersion :: Lens' DocumentVersionInfo (Maybe Bool) Source #
An identifier for the default version of the document.
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
- The association.fcaFault
- The source of the failure.fcaMessage
- A description of the failure.
fcaEntry :: Lens' FailedCreateAssociation (Maybe CreateAssociationBatchRequestEntry) Source #
The association.
fcaMessage :: Lens' FailedCreateAssociation (Maybe Text) Source #
A description of the failure.
InstanceAggregatedAssociationOverview
data InstanceAggregatedAssociationOverview Source #
Status information about the aggregated associations.
See: instanceAggregatedAssociationOverview
smart constructor.
instanceAggregatedAssociationOverview :: InstanceAggregatedAssociationOverview Source #
Creates a value of InstanceAggregatedAssociationOverview
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaaoDetailedStatus
- Detailed status information about the aggregated associations.iaaoInstanceAssociationStatusAggregatedCount
- The number of associations for the instance(s).
iaaoDetailedStatus :: Lens' InstanceAggregatedAssociationOverview (Maybe Text) Source #
Detailed status information about the aggregated associations.
iaaoInstanceAssociationStatusAggregatedCount :: Lens' InstanceAggregatedAssociationOverview (HashMap Text Int) Source #
The number of associations for the instance(s).
InstanceAssociation
data InstanceAssociation Source #
One or more association documents on the instance.
See: instanceAssociation
smart constructor.
instanceAssociation :: InstanceAssociation Source #
Creates a value of InstanceAssociation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaAssociationId
- The association ID.iaInstanceId
- The instance ID.iaContent
- The content of the association document for the instance(s).
iaAssociationId :: Lens' InstanceAssociation (Maybe Text) Source #
The association ID.
iaInstanceId :: Lens' InstanceAssociation (Maybe Text) Source #
The instance ID.
iaContent :: Lens' InstanceAssociation (Maybe Text) Source #
The content of the association document for the instance(s).
InstanceAssociationOutputLocation
data InstanceAssociationOutputLocation Source #
An Amazon S3 bucket where you want to store the results of this request.
See: instanceAssociationOutputLocation
smart constructor.
instanceAssociationOutputLocation :: InstanceAssociationOutputLocation Source #
Creates a value of InstanceAssociationOutputLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaolS3Location
- An Amazon S3 bucket where you want to store the results of this request.
iaolS3Location :: Lens' InstanceAssociationOutputLocation (Maybe S3OutputLocation) Source #
An Amazon S3 bucket where you want to store the results of this request.
InstanceAssociationOutputURL
data InstanceAssociationOutputURL Source #
The URL of Amazon S3 bucket where you want to store the results of this request.
See: instanceAssociationOutputURL
smart constructor.
instanceAssociationOutputURL :: InstanceAssociationOutputURL Source #
Creates a value of InstanceAssociationOutputURL
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaouS3OutputURL
- The URL of Amazon S3 bucket where you want to store the results of this request.
iaouS3OutputURL :: Lens' InstanceAssociationOutputURL (Maybe S3OutputURL) Source #
The URL of Amazon S3 bucket where you want to store the results of this request.
InstanceAssociationStatusInfo
data InstanceAssociationStatusInfo Source #
Status information about the instance association.
See: instanceAssociationStatusInfo
smart constructor.
instanceAssociationStatusInfo :: InstanceAssociationStatusInfo Source #
Creates a value of InstanceAssociationStatusInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iasiAssociationId
- The association ID.iasiInstanceId
- The instance ID where the association was created.iasiDetailedStatus
- Detailed status information about the instance association.iasiStatus
- Status information about the instance association.iasiOutputURL
- A URL for an Amazon S3 bucket where you want to store the results of this request.iasiExecutionSummary
- Summary information about association execution.iasiName
- The name of the association.iasiErrorCode
- An error code returned by the request to create the association.iasiDocumentVersion
- The association document verions.iasiExecutionDate
- The date the instance association executed.
iasiAssociationId :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #
The association ID.
iasiInstanceId :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #
The instance ID where the association was created.
iasiDetailedStatus :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #
Detailed status information about the instance association.
iasiStatus :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #
Status information about the instance association.
iasiOutputURL :: Lens' InstanceAssociationStatusInfo (Maybe InstanceAssociationOutputURL) Source #
A URL for an Amazon S3 bucket where you want to store the results of this request.
iasiExecutionSummary :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #
Summary information about association execution.
iasiErrorCode :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #
An error code returned by the request to create the association.
iasiDocumentVersion :: Lens' InstanceAssociationStatusInfo (Maybe Text) Source #
The association document verions.
iasiExecutionDate :: Lens' InstanceAssociationStatusInfo (Maybe UTCTime) Source #
The date the instance association executed.
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
- The instance ID.iiPingStatus
- Connection status of the SSM agent.iiIPAddress
- The IP address of the managed instance.iiResourceType
- The type of instance. Instances are either EC2 instances or managed instances.iiRegistrationDate
- The date the server or VM was registered with AWS as a managed instance.iiPlatformVersion
- The version of the OS platform running on your instance.iiIsLatestVersion
- Indicates whether latest version of the SSM agent is running on your instance.iiAgentVersion
- The version of the SSM agent running on your Linux instance.iiLastPingDateTime
- The date and time when agent last pinged Systems Manager service.iiLastSuccessfulAssociationExecutionDate
- The last date the association was successfully run.iiActivationId
- The activation ID created by Systems Manager when the server or VM was registered.iiName
- The name of the managed instance.iiPlatformType
- The operating system platform type.iiAssociationOverview
- Information about the association.iiAssociationStatus
- The status of the association.iiLastAssociationExecutionDate
- The date the association was last executed.iiPlatformName
- The name of the operating system platform running on your instance.iiComputerName
- The fully qualified host name of the managed instance.iiIAMRole
- The Amazon Identity and Access Management (IAM) role assigned to EC2 instances or managed instances.
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 Systems Manager service.
iiLastSuccessfulAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime) Source #
The last date the association was successfully run.
iiActivationId :: Lens' InstanceInformation (Maybe Text) Source #
The activation ID created by Systems Manager when the server or VM was registered.
iiPlatformType :: Lens' InstanceInformation (Maybe PlatformType) Source #
The operating system platform type.
iiAssociationOverview :: Lens' InstanceInformation (Maybe InstanceAggregatedAssociationOverview) Source #
Information about the association.
iiAssociationStatus :: Lens' InstanceInformation (Maybe Text) Source #
The status of the association.
iiLastAssociationExecutionDate :: Lens' InstanceInformation (Maybe UTCTime) Source #
The date the association was last executed.
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
- The name of the filter.iifValueSet
- The filter values.
iifKey :: Lens' InstanceInformationFilter InstanceInformationFilterKey Source #
The name of the filter.
iifValueSet :: Lens' InstanceInformationFilter (NonEmpty Text) Source #
The filter values.
InstanceInformationStringFilter
data InstanceInformationStringFilter Source #
The filters to describe or get information about your managed instances.
See: instanceInformationStringFilter
smart constructor.
instanceInformationStringFilter Source #
Creates a value of InstanceInformationStringFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iisfKey
- The filter key name to describe your instances. For example: InstanceIds|AgentVersion|PingStatus|PlatformTypes|ActivationIds|IamRole|ResourceType|”AssociationStatus”|”Tag Key”iisfValues
- The filter values.
iisfKey :: Lens' InstanceInformationStringFilter Text Source #
The filter key name to describe your instances. For example: InstanceIds|AgentVersion|PingStatus|PlatformTypes|ActivationIds|IamRole|ResourceType|”AssociationStatus”|”Tag Key”
iisfValues :: Lens' InstanceInformationStringFilter (NonEmpty Text) Source #
The filter values.
InventoryFilter
data InventoryFilter Source #
One or more filters. Use a filter to return a more specific list of results.
See: inventoryFilter
smart constructor.
Creates a value of InventoryFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ifType
- The type of filter. Valid values include the following: Equal|NotEqual|BeginWith|LessThan|GreaterThanifKey
- The name of the filter key.ifValues
- Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal
ifType :: Lens' InventoryFilter (Maybe InventoryQueryOperatorType) Source #
The type of filter. Valid values include the following: Equal|NotEqual|BeginWith|LessThan|GreaterThan
ifValues :: Lens' InventoryFilter (NonEmpty Text) Source #
Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal
InventoryItem
data InventoryItem Source #
Information collected from managed instances based on your inventory policy document
See: inventoryItem
smart constructor.
Creates a value of InventoryItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iiContentHash
- MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. ThePutInventory
API does not update the inventory item type contents if the MD5 hash has not changed since last update.iiContent
- The inventory data of the inventory type.iiTypeName
- The name of the inventory type. Default inventory item type names start withAWS
. Custom inventory type names will start withCustom
. Default inventory item types include the following:AWS:AWSComponent
,AWS:Application
,AWS:InstanceInformation
,AWS:Network
, andAWS:WindowsUpdate
.iiSchemaVersion
- The schema version for the inventory item.iiCaptureTime
- The time the inventory information was collected.
iiContentHash :: 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 does not update the inventory item type contents if the MD5 hash has not changed since last update.
iiContent :: Lens' InventoryItem [HashMap Text Text] Source #
The inventory data of the inventory type.
iiTypeName :: 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
.
iiSchemaVersion :: Lens' InventoryItem Text Source #
The schema version for the inventory item.
iiCaptureTime :: Lens' InventoryItem Text Source #
The time the inventory information was collected.
InventoryItemAttribute
data InventoryItemAttribute Source #
Attributes are the entries within the inventory item content. It contains name and value.
See: inventoryItemAttribute
smart constructor.
inventoryItemAttribute Source #
Creates a value of InventoryItemAttribute
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iiaName
- Name of the inventory item attribute.iiaDataType
- The data type of the inventory item attribute.
iiaDataType :: Lens' InventoryItemAttribute InventoryAttributeDataType Source #
The data type of the inventory item attribute.
InventoryItemSchema
data InventoryItemSchema Source #
The inventory item schema definition. Users can use this to compose inventory query filters.
See: inventoryItemSchema
smart constructor.
Creates a value of InventoryItemSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iisVersion
- The schema version for the inventory item.iisTypeName
- The name of the inventory type. Default inventory item type names start withAWS
. Custom inventory type names will start withCustom
. Default inventory item types include the following:AWS:AWSComponent
,AWS:Application
,AWS:InstanceInformation
,AWS:Network
, andAWS:WindowsUpdate
.iisAttributes
- The schema attributes for inventory. This contains data type and attribute name.
iisVersion :: Lens' InventoryItemSchema (Maybe Text) Source #
The schema version for the inventory item.
iisTypeName :: Lens' InventoryItemSchema 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
.
iisAttributes :: Lens' InventoryItemSchema (NonEmpty InventoryItemAttribute) Source #
The schema attributes for inventory. This contains data type and attribute name.
InventoryResultEntity
data InventoryResultEntity Source #
Inventory query results.
See: inventoryResultEntity
smart constructor.
inventoryResultEntity :: InventoryResultEntity Source #
Creates a value of InventoryResultEntity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ireData :: Lens' InventoryResultEntity (HashMap Text InventoryResultItem) Source #
The data section in the inventory result entity json.
ireId :: Lens' InventoryResultEntity (Maybe Text) Source #
ID of the inventory result entity. For example, for managed instance inventory the result will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.
InventoryResultItem
data InventoryResultItem Source #
The inventory result item.
See: inventoryResultItem
smart constructor.
Creates a value of InventoryResultItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iriContentHash
- MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. ThePutInventory
API does not update the inventory item type contents if the MD5 hash has not changed since last update.iriCaptureTime
- The time inventory item data was captured.iriTypeName
- The name of the inventory result item type.iriSchemaVersion
- The schema version for the inventory result item/iriContent
- Contains all the inventory data of the item type. Results include attribute names and values.
iriContentHash :: 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 does not update the inventory item type contents if the MD5 hash has not changed since last update.
iriCaptureTime :: Lens' InventoryResultItem (Maybe Text) Source #
The time inventory item data was captured.
iriTypeName :: Lens' InventoryResultItem Text Source #
The name of the inventory result item type.
iriSchemaVersion :: Lens' InventoryResultItem Text Source #
The schema version for the inventory result item/
iriContent :: Lens' InventoryResultItem [HashMap Text Text] Source #
Contains all the inventory data of the item type. Results include attribute names and values.
LoggingInfo
data LoggingInfo Source #
Information about an Amazon S3 bucket to write instance-level logs to.
See: loggingInfo
smart constructor.
Creates a value of LoggingInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
liS3KeyPrefix
- (Optional) The Amazon S3 bucket subfolder.liS3BucketName
- The name of an Amazon S3 bucket where execution logs are stored .liS3Region
- The region where the Amazon S3 bucket is located.
liS3KeyPrefix :: Lens' LoggingInfo (Maybe Text) Source #
(Optional) The Amazon S3 bucket subfolder.
liS3BucketName :: Lens' LoggingInfo Text Source #
The name of an Amazon S3 bucket where execution logs are stored .
liS3Region :: Lens' LoggingInfo Text Source #
The region where the Amazon S3 bucket is located.
MaintenanceWindowExecution
data MaintenanceWindowExecution Source #
Describes the information about an execution of a Maintenance Window.
See: maintenanceWindowExecution
smart constructor.
maintenanceWindowExecution :: MaintenanceWindowExecution Source #
Creates a value of MaintenanceWindowExecution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mweStatus
- The status of the execution.mweStartTime
- The time the execution started.mweWindowExecutionId
- The ID of the Maintenance Window execution.mweStatusDetails
- The details explaining the Status. Only available for certain status values.mweEndTime
- The time the execution finished.mweWindowId
- The ID of the Maintenance Window.
mweStatus :: Lens' MaintenanceWindowExecution (Maybe MaintenanceWindowExecutionStatus) Source #
The status of the execution.
mweStartTime :: Lens' MaintenanceWindowExecution (Maybe UTCTime) Source #
The time the execution started.
mweWindowExecutionId :: Lens' MaintenanceWindowExecution (Maybe Text) Source #
The ID of the Maintenance Window execution.
mweStatusDetails :: Lens' MaintenanceWindowExecution (Maybe Text) Source #
The details explaining the Status. Only available for certain status values.
mweEndTime :: Lens' MaintenanceWindowExecution (Maybe UTCTime) Source #
The time the execution finished.
mweWindowId :: Lens' MaintenanceWindowExecution (Maybe Text) Source #
The ID of the Maintenance Window.
MaintenanceWindowExecutionTaskIdentity
data MaintenanceWindowExecutionTaskIdentity Source #
Information about a task execution performed as part of a Maintenance Window execution.
See: maintenanceWindowExecutionTaskIdentity
smart constructor.
maintenanceWindowExecutionTaskIdentity :: MaintenanceWindowExecutionTaskIdentity Source #
Creates a value of MaintenanceWindowExecutionTaskIdentity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mwetiStatus
- The status of the task execution.mwetiTaskExecutionId
- The ID of the specific task execution in the Maintenance Window execution.mwetiStartTime
- The time the task execution started.mwetiTaskType
- The type of executed task.mwetiTaskARN
- The ARN of the executed task.mwetiWindowExecutionId
- The ID of the Maintenance Window execution that ran the task.mwetiStatusDetails
- The details explaining the status of the task execution. Only available for certain status values.mwetiEndTime
- The time the task execution finished.
mwetiStatus :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe MaintenanceWindowExecutionStatus) Source #
The status of the task execution.
mwetiTaskExecutionId :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text) Source #
The ID of the specific task execution in the Maintenance Window execution.
mwetiStartTime :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe UTCTime) Source #
The time the task execution started.
mwetiTaskType :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe MaintenanceWindowTaskType) Source #
The type of executed task.
mwetiTaskARN :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text) Source #
The ARN of the executed task.
mwetiWindowExecutionId :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text) Source #
The ID of the Maintenance Window execution that ran the task.
mwetiStatusDetails :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe Text) Source #
The details explaining the status of the task execution. Only available for certain status values.
mwetiEndTime :: Lens' MaintenanceWindowExecutionTaskIdentity (Maybe UTCTime) Source #
The time the task execution finished.
MaintenanceWindowExecutionTaskInvocationIdentity
data MaintenanceWindowExecutionTaskInvocationIdentity Source #
Describes the information about a task invocation for a particular target as part of a task execution performed as part of a Maintenance Window execution.
See: maintenanceWindowExecutionTaskInvocationIdentity
smart constructor.
maintenanceWindowExecutionTaskInvocationIdentity :: MaintenanceWindowExecutionTaskInvocationIdentity Source #
Creates a value of MaintenanceWindowExecutionTaskInvocationIdentity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mwetiiStatus
- The status of the task invocation.mwetiiExecutionId
- 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.mwetiiTaskExecutionId
- The ID of the specific task execution in the Maintenance Window execution.mwetiiStartTime
- The time the invocation started.mwetiiInvocationId
- The ID of the task invocation.mwetiiOwnerInformation
- User-provided value that was specified when the target was registered with the Maintenance Window. This was also included in any CloudWatch events raised during the task invocation.mwetiiWindowTargetId
- The ID of the target definition in this Maintenance Window the invocation was performed for.mwetiiWindowExecutionId
- The ID of the Maintenance Window execution that ran the task.mwetiiStatusDetails
- The details explaining the status of the task invocation. Only available for certain Status values.mwetiiEndTime
- The time the invocation finished.mwetiiParameters
- The parameters that were provided for the invocation when it was executed.
mwetiiStatus :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe MaintenanceWindowExecutionStatus) Source #
The status of the task invocation.
mwetiiExecutionId :: 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.
mwetiiTaskExecutionId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #
The ID of the specific task execution in the Maintenance Window execution.
mwetiiStartTime :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe UTCTime) Source #
The time the invocation started.
mwetiiInvocationId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #
The ID of the task invocation.
mwetiiOwnerInformation :: 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 CloudWatch events raised during the task invocation.
mwetiiWindowTargetId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #
The ID of the target definition in this Maintenance Window the invocation was performed for.
mwetiiWindowExecutionId :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #
The ID of the Maintenance Window execution that ran the task.
mwetiiStatusDetails :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #
The details explaining the status of the task invocation. Only available for certain Status values.
mwetiiEndTime :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe UTCTime) Source #
The time the invocation finished.
mwetiiParameters :: Lens' MaintenanceWindowExecutionTaskInvocationIdentity (Maybe Text) Source #
The parameters that were provided for the invocation when it was executed.
MaintenanceWindowFilter
data MaintenanceWindowFilter Source #
Filter used in the request.
See: maintenanceWindowFilter
smart constructor.
maintenanceWindowFilter :: MaintenanceWindowFilter Source #
Creates a value of MaintenanceWindowFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
MaintenanceWindowIdentity
data MaintenanceWindowIdentity Source #
Information about the Maintenance Window.
See: maintenanceWindowIdentity
smart constructor.
maintenanceWindowIdentity :: MaintenanceWindowIdentity Source #
Creates a value of MaintenanceWindowIdentity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mwiEnabled
- Whether the Maintenance Window is enabled.mwiName
- The name of the Maintenance Window.mwiCutoff
- The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.mwiDuration
- The duration of the Maintenance Window in hours.mwiWindowId
- The ID of the Maintenance Window.
mwiEnabled :: Lens' MaintenanceWindowIdentity (Maybe Bool) Source #
Whether the Maintenance Window is enabled.
mwiCutoff :: Lens' MaintenanceWindowIdentity (Maybe Natural) Source #
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
mwiDuration :: Lens' MaintenanceWindowIdentity (Maybe Natural) Source #
The duration of the Maintenance Window in hours.
mwiWindowId :: Lens' MaintenanceWindowIdentity (Maybe Text) Source #
The ID of the Maintenance Window.
MaintenanceWindowTarget
data MaintenanceWindowTarget Source #
The target registered with the Maintenance Window.
See: maintenanceWindowTarget
smart constructor.
maintenanceWindowTarget :: MaintenanceWindowTarget Source #
Creates a value of MaintenanceWindowTarget
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mResourceType
- The type of target.mOwnerInformation
- User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.mWindowTargetId
- The ID of the target.mTargets
- The targets (either instances or tags). Instances are specified using Key=instanceids,Values=instanceid1,instanceid2. Tags are specified using Key=name,Values=value.mWindowId
- The Maintenance Window ID where the target is registered.
mResourceType :: Lens' MaintenanceWindowTarget (Maybe MaintenanceWindowResourceType) Source #
The type of target.
mOwnerInformation :: Lens' MaintenanceWindowTarget (Maybe Text) Source #
User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
mWindowTargetId :: Lens' MaintenanceWindowTarget (Maybe Text) Source #
The ID of the target.
mTargets :: Lens' MaintenanceWindowTarget [Target] Source #
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=instanceid1,instanceid2. Tags are specified using Key=name,Values=value.
mWindowId :: Lens' MaintenanceWindowTarget (Maybe Text) Source #
The Maintenance Window ID where the target is registered.
MaintenanceWindowTask
data MaintenanceWindowTask Source #
Information about a task defined for a Maintenance Window.
See: maintenanceWindowTask
smart constructor.
maintenanceWindowTask :: MaintenanceWindowTask Source #
Creates a value of MaintenanceWindowTask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mwtServiceRoleARN
- The role that should be assumed when executing the taskmwtWindowTaskId
- The task ID.mwtTaskParameters
- The parameters that should be passed to the task when it is executed.mwtPriority
- 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.mwtTaskARN
- The ARN of the task to execute.mwtMaxErrors
- The maximum number of errors allowed before this task stops being scheduled.mwtTargets
- The targets (either instances or tags). Instances are specified using Key=instanceids,Values=instanceid1,instanceid2. Tags are specified using Key=name,Values=value.mwtLoggingInfo
- Information about an Amazon S3 bucket to write task-level logs to.mwtType
- The type of task.mwtMaxConcurrency
- The maximum number of targets this task can be run for in parallel.mwtWindowId
- The Maintenance Window ID where the task is registered.
mwtServiceRoleARN :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The role that should be assumed when executing the task
mwtWindowTaskId :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The task ID.
mwtTaskParameters :: Lens' MaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #
The parameters that should be passed to the task when it is executed.
mwtPriority :: Lens' MaintenanceWindowTask (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.
mwtTaskARN :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The ARN of the task to execute.
mwtMaxErrors :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The maximum number of errors allowed before this task stops being scheduled.
mwtTargets :: Lens' MaintenanceWindowTask [Target] Source #
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=instanceid1,instanceid2. Tags are specified using Key=name,Values=value.
mwtLoggingInfo :: Lens' MaintenanceWindowTask (Maybe LoggingInfo) Source #
Information about an Amazon S3 bucket to write task-level logs to.
mwtType :: Lens' MaintenanceWindowTask (Maybe MaintenanceWindowTaskType) Source #
The type of task.
mwtMaxConcurrency :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The maximum number of targets this task can be run for in parallel.
mwtWindowId :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The Maintenance Window ID where the task is registered.
MaintenanceWindowTaskParameterValueExpression
data MaintenanceWindowTaskParameterValueExpression Source #
Defines the values for a task parameter.
See: maintenanceWindowTaskParameterValueExpression
smart constructor.
maintenanceWindowTaskParameterValueExpression :: MaintenanceWindowTaskParameterValueExpression Source #
Creates a value of MaintenanceWindowTaskParameterValueExpression
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mwtpveValues
- This field contains an array of 0 or more strings, each 1 to 255 characters in length.
mwtpveValues :: Lens' MaintenanceWindowTaskParameterValueExpression (Maybe [Text]) Source #
This field contains an array of 0 or more strings, each 1 to 255 characters in length.
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
- 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
- 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
- An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
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. Run Command pushes notifications about command status changes to this topic.
Parameter
An Amazon EC2 Systems Manager parameter in Parameter Store.
See: parameter
smart constructor.
parameter :: Parameter Source #
Creates a value of Parameter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pType :: Lens' Parameter (Maybe ParameterType) Source #
The type of parameter. Valid values include the following: String, String list, Secure string.
ParameterHistory
data ParameterHistory Source #
Information about parameter usage.
See: parameterHistory
smart constructor.
parameterHistory :: ParameterHistory Source #
Creates a value of ParameterHistory
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
phLastModifiedDate
- Date the parameter was last changed or updated.phKeyId
- The ID of the query key used for this parameter.phValue
- The parameter value.phName
- The name of the parameter.phLastModifiedUser
- Amazon Resource Name (ARN) of the AWS user who last changed the parameter.phType
- The type of parameter used.phDescription
- Information about the parameter.
phLastModifiedDate :: Lens' ParameterHistory (Maybe UTCTime) Source #
Date the parameter was last changed or updated.
phKeyId :: Lens' ParameterHistory (Maybe Text) Source #
The ID of the query key used for this parameter.
phLastModifiedUser :: Lens' ParameterHistory (Maybe Text) Source #
Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
phType :: Lens' ParameterHistory (Maybe ParameterType) Source #
The type of parameter used.
phDescription :: Lens' ParameterHistory (Maybe Text) Source #
Information about the parameter.
ParameterMetadata
data ParameterMetadata Source #
Metada includes information like the ARN of the last user and the date/time the parameter was last used.
See: parameterMetadata
smart constructor.
parameterMetadata :: ParameterMetadata Source #
Creates a value of ParameterMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pmLastModifiedDate
- Date the parameter was last changed or updated.pmKeyId
- The ID of the query key used for this parameter.pmName
- The parameter name.pmLastModifiedUser
- Amazon Resource Name (ARN) of the AWS user who last changed the parameter.pmType
- The type of parameter. Valid parameter types include the following: String, String list, Secure string.pmDescription
- Description of the parameter actions.
pmLastModifiedDate :: Lens' ParameterMetadata (Maybe UTCTime) Source #
Date the parameter was last changed or updated.
pmKeyId :: Lens' ParameterMetadata (Maybe Text) Source #
The ID of the query key used for this parameter.
pmLastModifiedUser :: Lens' ParameterMetadata (Maybe Text) Source #
Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
pmType :: Lens' ParameterMetadata (Maybe ParameterType) Source #
The type of parameter. Valid parameter types include the following: String, String list, Secure string.
pmDescription :: Lens' ParameterMetadata (Maybe Text) Source #
Description of the parameter actions.
ParametersFilter
data ParametersFilter Source #
One or more filters. Use a filter to return a more specific list of results.
See: parametersFilter
smart constructor.
Creates a value of ParametersFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pfKey :: Lens' ParametersFilter (Maybe ParametersFilterKey) Source #
The name of the filter.
ResultAttribute
data ResultAttribute Source #
The inventory item result attribute.
See: resultAttribute
smart constructor.
Creates a value of ResultAttribute
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
raTypeName
- Name of the inventory item type. Valid value: “AWS:InstanceInformation”. Default Value: “AWS:InstanceInformation”.
raTypeName :: Lens' ResultAttribute Text Source #
Name of the inventory item type. Valid value: “AWS:InstanceInformation”. Default Value: “AWS:InstanceInformation”.
S3OutputLocation
data S3OutputLocation Source #
An Amazon S3 bucket where you want to store the results of this request.
See: s3OutputLocation
smart constructor.
s3OutputLocation :: S3OutputLocation Source #
Creates a value of S3OutputLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
solOutputS3KeyPrefix
- The Amazon S3 bucket subfolder.solOutputS3Region
- The Amazon S3 region where the association information is stored.solOutputS3BucketName
- The name of the Amazon S3 bucket.
solOutputS3KeyPrefix :: Lens' S3OutputLocation (Maybe Text) Source #
The Amazon S3 bucket subfolder.
solOutputS3Region :: Lens' S3OutputLocation (Maybe Text) Source #
The Amazon S3 region where the association information is stored.
solOutputS3BucketName :: Lens' S3OutputLocation (Maybe Text) Source #
The name of the Amazon S3 bucket.
S3OutputURL
data S3OutputURL Source #
A URL for the Amazon S3 bucket where you want to store the results of this request.
See: s3OutputURL
smart constructor.
s3OutputURL :: S3OutputURL Source #
Creates a value of S3OutputURL
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
souOutputURL
- A URL for an Amazon S3 bucket where you want to store the results of this request.
souOutputURL :: Lens' S3OutputURL (Maybe Text) Source #
A URL for an Amazon S3 bucket where you want to store the results of this request.
StepExecution
data StepExecution Source #
Detailed information about an the execution state of an Automation step.
See: stepExecution
smart constructor.
stepExecution :: StepExecution Source #
Creates a value of StepExecution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
seInputs
- Fully-resolved values passed into the step before execution.seStepName
- The name of this execution step.seExecutionEndTime
- If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.seFailureMessage
- If a step failed, this message explains why the execution failed.seResponse
- A message associated with the response code for an execution.seAction
- The action this step performs. The action determines the behavior of the step.seResponseCode
- The response code returned by the execution of the step.seStepStatus
- The execution status for this step. Valid values include:Pending
,InProgress
,Success
,Cancelled
,Failed
, andTimedOut
.seOutputs
- Returned values from the execution of the step.seExecutionStartTime
- If a step has begun execution, this contains the time the step started. If the step is inPending
status, this field is not populated.
seInputs :: Lens' StepExecution (HashMap Text Text) Source #
Fully-resolved values passed into the step before execution.
seStepName :: Lens' StepExecution (Maybe Text) Source #
The name of this execution step.
seExecutionEndTime :: Lens' StepExecution (Maybe UTCTime) Source #
If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
seFailureMessage :: Lens' StepExecution (Maybe Text) Source #
If a step failed, this message explains why the execution failed.
seResponse :: Lens' StepExecution (Maybe Text) Source #
A message associated with the response code for an execution.
seAction :: Lens' StepExecution (Maybe Text) Source #
The action this step performs. The action determines the behavior of the step.
seResponseCode :: Lens' StepExecution (Maybe Text) Source #
The response code returned by the execution of the step.
seStepStatus :: Lens' StepExecution (Maybe AutomationExecutionStatus) Source #
The execution status for this step. Valid values include: Pending
, InProgress
, Success
, Cancelled
, Failed
, and TimedOut
.
seOutputs :: Lens' StepExecution (HashMap Text [Text]) Source #
Returned values from the execution of the step.
seExecutionStartTime :: 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 is not populated.
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.
Target
An array of search criteria that targets instances using a Key
;Value
combination that you specify. Targets
is required if you don't provide one or more instance IDs in the call.
See: target
smart constructor.
Creates a value of Target
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tValues
- User-defined criteria that maps toKey
. For example, if you specifiedtag:ServerRole
, you could specifyvalue:WebServer
to execute a command on instances that include Amazon EC2 tags of ServerRole;WebServer. For more information about how to send commands that target instances usingKey
;Value
parameters, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).tKey
- User-defined criteria for sending commands that target instances that meet the criteria.Key
can betag:EC2 tag
orname:EC2 instance ID
. For example,tag:ServerRole
orname:0123456789012345
. For more information about how to send commands that target instances usingKey
;Value
parameters, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
tValues :: Lens' Target [Text] Source #
User-defined criteria that maps to Key
. For example, if you specified tag:ServerRole
, you could specify value:WebServer
to execute a command on instances that include Amazon EC2 tags of ServerRole;WebServer. For more information about how to send commands that target instances using Key
;Value
parameters, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
tKey :: Lens' Target (Maybe Text) Source #
User-defined criteria for sending commands that target instances that meet the criteria. Key
can be tag:EC2 tag
or name:EC2 instance ID
. For example, tag:ServerRole
or name:0123456789012345
. For more information about how to send commands that target instances using Key
;Value
parameters, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).