Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- AccountHasOngoingImportException
- AccountNotFoundException
- AccountNotRegisteredException
- AccountRegisteredException
- CannotDelegateManagementAccountException
- ChannelARNInvalidException
- ChannelNotFoundException
- CloudTrailARNInvalidException
- CloudTrailAccessNotEnabledException
- CloudTrailInvalidClientTokenIdException
- CloudWatchLogsDeliveryUnavailableException
- ConflictException
- DelegatedAdminAccountLimitExceededException
- EventDataStoreARNInvalidException
- EventDataStoreAlreadyExistsException
- EventDataStoreHasOngoingImportException
- EventDataStoreMaxLimitExceededException
- EventDataStoreNotFoundException
- EventDataStoreTerminationProtectedException
- ImportNotFoundException
- InactiveEventDataStoreException
- InactiveQueryException
- InsightNotEnabledException
- InsufficientDependencyServiceAccessPermissionException
- InsufficientEncryptionPolicyException
- InsufficientS3BucketPolicyException
- InsufficientSnsTopicPolicyException
- InvalidCloudWatchLogsLogGroupArnException
- InvalidCloudWatchLogsRoleArnException
- InvalidDateRangeException
- InvalidEventCategoryException
- InvalidEventDataStoreCategoryException
- InvalidEventDataStoreStatusException
- InvalidEventSelectorsException
- InvalidHomeRegionException
- InvalidImportSourceException
- InvalidInsightSelectorsException
- InvalidKmsKeyIdException
- InvalidLookupAttributesException
- InvalidMaxResultsException
- InvalidNextTokenException
- InvalidParameterCombinationException
- InvalidParameterException
- InvalidQueryStatementException
- InvalidQueryStatusException
- InvalidS3BucketNameException
- InvalidS3PrefixException
- InvalidSnsTopicNameException
- InvalidTagParameterException
- InvalidTimeRangeException
- InvalidTokenException
- InvalidTrailNameException
- KmsException
- KmsKeyDisabledException
- KmsKeyNotFoundException
- MaxConcurrentQueriesException
- MaximumNumberOfTrailsExceededException
- NoManagementAccountSLRExistsException
- NotOrganizationManagementAccountException
- NotOrganizationMasterAccountException
- OperationNotPermittedException
- OrganizationNotInAllFeaturesModeException
- OrganizationsNotInUseException
- QueryIdNotFoundException
- ResourceNotFoundException
- ResourceTypeNotSupportedException
- S3BucketDoesNotExistException
- TagsLimitExceededException
- TrailAlreadyExistsException
- TrailNotFoundException
- TrailNotProvidedException
- UnsupportedOperationException
- Waiters
- Operations
- AddTags
- CancelQuery
- CreateEventDataStore
- CreateTrail
- DeleteEventDataStore
- DeleteTrail
- DeregisterOrganizationDelegatedAdmin
- DescribeQuery
- DescribeTrails
- GetChannel
- GetEventDataStore
- GetEventSelectors
- GetImport
- GetInsightSelectors
- GetQueryResults
- GetTrail
- GetTrailStatus
- ListChannels
- ListEventDataStores
- ListImportFailures (Paginated)
- ListImports (Paginated)
- ListPublicKeys (Paginated)
- ListQueries
- ListTags (Paginated)
- ListTrails (Paginated)
- LookupEvents (Paginated)
- PutEventSelectors
- PutInsightSelectors
- RegisterOrganizationDelegatedAdmin
- RemoveTags
- RestoreEventDataStore
- StartImport
- StartLogging
- StartQuery
- StopImport
- StopLogging
- UpdateEventDataStore
- UpdateTrail
- Types
- DeliveryStatus
- DestinationType
- EventCategory
- EventDataStoreStatus
- ImportFailureStatus
- ImportStatus
- InsightType
- LookupAttributeKey
- QueryStatus
- ReadWriteType
- AdvancedEventSelector
- AdvancedFieldSelector
- Channel
- DataResource
- Destination
- Event
- EventDataStore
- EventSelector
- ImportFailureListItem
- ImportSource
- ImportStatistics
- ImportsListItem
- InsightSelector
- LookupAttribute
- PublicKey
- Query
- QueryStatistics
- QueryStatisticsForDescribeQuery
- Resource
- ResourceTag
- S3ImportSource
- SourceConfig
- Tag
- Trail
- TrailInfo
Derived from API version 2013-11-01
of the AWS service descriptions, licensed under Apache 2.0.
CloudTrail
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.
As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
Synopsis
- defaultService :: Service
- _AccountHasOngoingImportException :: AsError a => Fold a ServiceError
- _AccountNotFoundException :: AsError a => Fold a ServiceError
- _AccountNotRegisteredException :: AsError a => Fold a ServiceError
- _AccountRegisteredException :: AsError a => Fold a ServiceError
- _CannotDelegateManagementAccountException :: AsError a => Fold a ServiceError
- _ChannelARNInvalidException :: AsError a => Fold a ServiceError
- _ChannelNotFoundException :: AsError a => Fold a ServiceError
- _CloudTrailARNInvalidException :: AsError a => Fold a ServiceError
- _CloudTrailAccessNotEnabledException :: AsError a => Fold a ServiceError
- _CloudTrailInvalidClientTokenIdException :: AsError a => Fold a ServiceError
- _CloudWatchLogsDeliveryUnavailableException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _DelegatedAdminAccountLimitExceededException :: AsError a => Fold a ServiceError
- _EventDataStoreARNInvalidException :: AsError a => Fold a ServiceError
- _EventDataStoreAlreadyExistsException :: AsError a => Fold a ServiceError
- _EventDataStoreHasOngoingImportException :: AsError a => Fold a ServiceError
- _EventDataStoreMaxLimitExceededException :: AsError a => Fold a ServiceError
- _EventDataStoreNotFoundException :: AsError a => Fold a ServiceError
- _EventDataStoreTerminationProtectedException :: AsError a => Fold a ServiceError
- _ImportNotFoundException :: AsError a => Fold a ServiceError
- _InactiveEventDataStoreException :: AsError a => Fold a ServiceError
- _InactiveQueryException :: AsError a => Fold a ServiceError
- _InsightNotEnabledException :: AsError a => Fold a ServiceError
- _InsufficientDependencyServiceAccessPermissionException :: AsError a => Fold a ServiceError
- _InsufficientEncryptionPolicyException :: AsError a => Fold a ServiceError
- _InsufficientS3BucketPolicyException :: AsError a => Fold a ServiceError
- _InsufficientSnsTopicPolicyException :: AsError a => Fold a ServiceError
- _InvalidCloudWatchLogsLogGroupArnException :: AsError a => Fold a ServiceError
- _InvalidCloudWatchLogsRoleArnException :: AsError a => Fold a ServiceError
- _InvalidDateRangeException :: AsError a => Fold a ServiceError
- _InvalidEventCategoryException :: AsError a => Fold a ServiceError
- _InvalidEventDataStoreCategoryException :: AsError a => Fold a ServiceError
- _InvalidEventDataStoreStatusException :: AsError a => Fold a ServiceError
- _InvalidEventSelectorsException :: AsError a => Fold a ServiceError
- _InvalidHomeRegionException :: AsError a => Fold a ServiceError
- _InvalidImportSourceException :: AsError a => Fold a ServiceError
- _InvalidInsightSelectorsException :: AsError a => Fold a ServiceError
- _InvalidKmsKeyIdException :: AsError a => Fold a ServiceError
- _InvalidLookupAttributesException :: AsError a => Fold a ServiceError
- _InvalidMaxResultsException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidParameterCombinationException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidQueryStatementException :: AsError a => Fold a ServiceError
- _InvalidQueryStatusException :: AsError a => Fold a ServiceError
- _InvalidS3BucketNameException :: AsError a => Fold a ServiceError
- _InvalidS3PrefixException :: AsError a => Fold a ServiceError
- _InvalidSnsTopicNameException :: AsError a => Fold a ServiceError
- _InvalidTagParameterException :: AsError a => Fold a ServiceError
- _InvalidTimeRangeException :: AsError a => Fold a ServiceError
- _InvalidTokenException :: AsError a => Fold a ServiceError
- _InvalidTrailNameException :: AsError a => Fold a ServiceError
- _KmsException :: AsError a => Fold a ServiceError
- _KmsKeyDisabledException :: AsError a => Fold a ServiceError
- _KmsKeyNotFoundException :: AsError a => Fold a ServiceError
- _MaxConcurrentQueriesException :: AsError a => Fold a ServiceError
- _MaximumNumberOfTrailsExceededException :: AsError a => Fold a ServiceError
- _NoManagementAccountSLRExistsException :: AsError a => Fold a ServiceError
- _NotOrganizationManagementAccountException :: AsError a => Fold a ServiceError
- _NotOrganizationMasterAccountException :: AsError a => Fold a ServiceError
- _OperationNotPermittedException :: AsError a => Fold a ServiceError
- _OrganizationNotInAllFeaturesModeException :: AsError a => Fold a ServiceError
- _OrganizationsNotInUseException :: AsError a => Fold a ServiceError
- _QueryIdNotFoundException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ResourceTypeNotSupportedException :: AsError a => Fold a ServiceError
- _S3BucketDoesNotExistException :: AsError a => Fold a ServiceError
- _TagsLimitExceededException :: AsError a => Fold a ServiceError
- _TrailAlreadyExistsException :: AsError a => Fold a ServiceError
- _TrailNotFoundException :: AsError a => Fold a ServiceError
- _TrailNotProvidedException :: AsError a => Fold a ServiceError
- _UnsupportedOperationException :: AsError a => Fold a ServiceError
- data AddTags = AddTags' Text [Tag]
- newAddTags :: Text -> AddTags
- data AddTagsResponse = AddTagsResponse' Int
- newAddTagsResponse :: Int -> AddTagsResponse
- data CancelQuery = CancelQuery' (Maybe Text) Text
- newCancelQuery :: Text -> CancelQuery
- data CancelQueryResponse = CancelQueryResponse' Int Text QueryStatus
- newCancelQueryResponse :: Int -> Text -> QueryStatus -> CancelQueryResponse
- data CreateEventDataStore = CreateEventDataStore' (Maybe [AdvancedEventSelector]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe [Tag]) (Maybe Bool) Text
- newCreateEventDataStore :: Text -> CreateEventDataStore
- data CreateEventDataStoreResponse = CreateEventDataStoreResponse' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe [Tag]) (Maybe Bool) (Maybe POSIX) Int
- newCreateEventDataStoreResponse :: Int -> CreateEventDataStoreResponse
- data CreateTrail = CreateTrail' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text
- newCreateTrail :: Text -> Text -> CreateTrail
- data CreateTrailResponse = CreateTrailResponse' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateTrailResponse :: Int -> CreateTrailResponse
- data DeleteEventDataStore = DeleteEventDataStore' Text
- newDeleteEventDataStore :: Text -> DeleteEventDataStore
- data DeleteEventDataStoreResponse = DeleteEventDataStoreResponse' Int
- newDeleteEventDataStoreResponse :: Int -> DeleteEventDataStoreResponse
- data DeleteTrail = DeleteTrail' Text
- newDeleteTrail :: Text -> DeleteTrail
- data DeleteTrailResponse = DeleteTrailResponse' Int
- newDeleteTrailResponse :: Int -> DeleteTrailResponse
- data DeregisterOrganizationDelegatedAdmin = DeregisterOrganizationDelegatedAdmin' Text
- newDeregisterOrganizationDelegatedAdmin :: Text -> DeregisterOrganizationDelegatedAdmin
- data DeregisterOrganizationDelegatedAdminResponse = DeregisterOrganizationDelegatedAdminResponse' Int
- newDeregisterOrganizationDelegatedAdminResponse :: Int -> DeregisterOrganizationDelegatedAdminResponse
- data DescribeQuery = DescribeQuery' (Maybe Text) Text
- newDescribeQuery :: Text -> DescribeQuery
- data DescribeQueryResponse = DescribeQueryResponse' (Maybe Text) (Maybe DeliveryStatus) (Maybe Text) (Maybe Text) (Maybe QueryStatisticsForDescribeQuery) (Maybe QueryStatus) (Maybe Text) Int
- newDescribeQueryResponse :: Int -> DescribeQueryResponse
- data DescribeTrails = DescribeTrails' (Maybe Bool) (Maybe [Text])
- newDescribeTrails :: DescribeTrails
- data DescribeTrailsResponse = DescribeTrailsResponse' (Maybe [Trail]) Int
- newDescribeTrailsResponse :: Int -> DescribeTrailsResponse
- data GetChannel = GetChannel' Text
- newGetChannel :: Text -> GetChannel
- data GetChannelResponse = GetChannelResponse' (Maybe Text) (Maybe (NonEmpty Destination)) (Maybe Text) (Maybe Text) (Maybe SourceConfig) Int
- newGetChannelResponse :: Int -> GetChannelResponse
- data GetEventDataStore = GetEventDataStore' Text
- newGetEventDataStore :: Text -> GetEventDataStore
- data GetEventDataStoreResponse = GetEventDataStoreResponse' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe Bool) (Maybe POSIX) Int
- newGetEventDataStoreResponse :: Int -> GetEventDataStoreResponse
- data GetEventSelectors = GetEventSelectors' Text
- newGetEventSelectors :: Text -> GetEventSelectors
- data GetEventSelectorsResponse = GetEventSelectorsResponse' (Maybe [AdvancedEventSelector]) (Maybe [EventSelector]) (Maybe Text) Int
- newGetEventSelectorsResponse :: Int -> GetEventSelectorsResponse
- data GetImport = GetImport' Text
- newGetImport :: Text -> GetImport
- data GetImportResponse = GetImportResponse' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe ImportSource) (Maybe ImportStatistics) (Maybe ImportStatus) (Maybe POSIX) (Maybe POSIX) Int
- newGetImportResponse :: Int -> GetImportResponse
- data GetInsightSelectors = GetInsightSelectors' Text
- newGetInsightSelectors :: Text -> GetInsightSelectors
- data GetInsightSelectorsResponse = GetInsightSelectorsResponse' (Maybe [InsightSelector]) (Maybe Text) Int
- newGetInsightSelectorsResponse :: Int -> GetInsightSelectorsResponse
- data GetQueryResults = GetQueryResults' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newGetQueryResults :: Text -> GetQueryResults
- data GetQueryResultsResponse = GetQueryResultsResponse' (Maybe Text) (Maybe Text) (Maybe [[HashMap Text Text]]) (Maybe QueryStatistics) (Maybe QueryStatus) Int
- newGetQueryResultsResponse :: Int -> GetQueryResultsResponse
- data GetTrail = GetTrail' Text
- newGetTrail :: Text -> GetTrail
- data GetTrailResponse = GetTrailResponse' (Maybe Trail) Int
- newGetTrailResponse :: Int -> GetTrailResponse
- data GetTrailStatus = GetTrailStatus' Text
- newGetTrailStatus :: Text -> GetTrailStatus
- data GetTrailStatusResponse = GetTrailStatusResponse' (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newGetTrailStatusResponse :: Int -> GetTrailStatusResponse
- data ListChannels = ListChannels' (Maybe Natural) (Maybe Text)
- newListChannels :: ListChannels
- data ListChannelsResponse = ListChannelsResponse' (Maybe [Channel]) (Maybe Text) Int
- newListChannelsResponse :: Int -> ListChannelsResponse
- data ListEventDataStores = ListEventDataStores' (Maybe Natural) (Maybe Text)
- newListEventDataStores :: ListEventDataStores
- data ListEventDataStoresResponse = ListEventDataStoresResponse' (Maybe [EventDataStore]) (Maybe Text) Int
- newListEventDataStoresResponse :: Int -> ListEventDataStoresResponse
- data ListImportFailures = ListImportFailures' (Maybe Natural) (Maybe Text) Text
- newListImportFailures :: Text -> ListImportFailures
- data ListImportFailuresResponse = ListImportFailuresResponse' (Maybe [ImportFailureListItem]) (Maybe Text) Int
- newListImportFailuresResponse :: Int -> ListImportFailuresResponse
- data ListImports = ListImports' (Maybe Text) (Maybe ImportStatus) (Maybe Natural) (Maybe Text)
- newListImports :: ListImports
- data ListImportsResponse = ListImportsResponse' (Maybe [ImportsListItem]) (Maybe Text) Int
- newListImportsResponse :: Int -> ListImportsResponse
- data ListPublicKeys = ListPublicKeys' (Maybe POSIX) (Maybe Text) (Maybe POSIX)
- newListPublicKeys :: ListPublicKeys
- data ListPublicKeysResponse = ListPublicKeysResponse' (Maybe Text) (Maybe [PublicKey]) Int
- newListPublicKeysResponse :: Int -> ListPublicKeysResponse
- data ListQueries = ListQueries' (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe QueryStatus) (Maybe POSIX) Text
- newListQueries :: Text -> ListQueries
- data ListQueriesResponse = ListQueriesResponse' (Maybe Text) (Maybe [Query]) Int
- newListQueriesResponse :: Int -> ListQueriesResponse
- data ListTags = ListTags' (Maybe Text) [Text]
- newListTags :: ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe Text) (Maybe [ResourceTag]) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data ListTrails = ListTrails' (Maybe Text)
- newListTrails :: ListTrails
- data ListTrailsResponse = ListTrailsResponse' (Maybe Text) (Maybe [TrailInfo]) Int
- newListTrailsResponse :: Int -> ListTrailsResponse
- data LookupEvents = LookupEvents' (Maybe POSIX) (Maybe EventCategory) (Maybe [LookupAttribute]) (Maybe Natural) (Maybe Text) (Maybe POSIX)
- newLookupEvents :: LookupEvents
- data LookupEventsResponse = LookupEventsResponse' (Maybe [Event]) (Maybe Text) Int
- newLookupEventsResponse :: Int -> LookupEventsResponse
- data PutEventSelectors = PutEventSelectors' (Maybe [AdvancedEventSelector]) (Maybe [EventSelector]) Text
- newPutEventSelectors :: Text -> PutEventSelectors
- data PutEventSelectorsResponse = PutEventSelectorsResponse' (Maybe [AdvancedEventSelector]) (Maybe [EventSelector]) (Maybe Text) Int
- newPutEventSelectorsResponse :: Int -> PutEventSelectorsResponse
- data PutInsightSelectors = PutInsightSelectors' Text [InsightSelector]
- newPutInsightSelectors :: Text -> PutInsightSelectors
- data PutInsightSelectorsResponse = PutInsightSelectorsResponse' (Maybe [InsightSelector]) (Maybe Text) Int
- newPutInsightSelectorsResponse :: Int -> PutInsightSelectorsResponse
- data RegisterOrganizationDelegatedAdmin = RegisterOrganizationDelegatedAdmin' Text
- newRegisterOrganizationDelegatedAdmin :: Text -> RegisterOrganizationDelegatedAdmin
- data RegisterOrganizationDelegatedAdminResponse = RegisterOrganizationDelegatedAdminResponse' Int
- newRegisterOrganizationDelegatedAdminResponse :: Int -> RegisterOrganizationDelegatedAdminResponse
- data RemoveTags = RemoveTags' Text [Tag]
- newRemoveTags :: Text -> RemoveTags
- data RemoveTagsResponse = RemoveTagsResponse' Int
- newRemoveTagsResponse :: Int -> RemoveTagsResponse
- data RestoreEventDataStore = RestoreEventDataStore' Text
- newRestoreEventDataStore :: Text -> RestoreEventDataStore
- data RestoreEventDataStoreResponse = RestoreEventDataStoreResponse' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe Bool) (Maybe POSIX) Int
- newRestoreEventDataStoreResponse :: Int -> RestoreEventDataStoreResponse
- data StartImport = StartImport' (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe ImportSource) (Maybe POSIX)
- newStartImport :: StartImport
- data StartImportResponse = StartImportResponse' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe ImportSource) (Maybe ImportStatus) (Maybe POSIX) (Maybe POSIX) Int
- newStartImportResponse :: Int -> StartImportResponse
- data StartLogging = StartLogging' Text
- newStartLogging :: Text -> StartLogging
- data StartLoggingResponse = StartLoggingResponse' Int
- newStartLoggingResponse :: Int -> StartLoggingResponse
- data StartQuery = StartQuery' (Maybe Text) Text
- newStartQuery :: Text -> StartQuery
- data StartQueryResponse = StartQueryResponse' (Maybe Text) Int
- newStartQueryResponse :: Int -> StartQueryResponse
- data StopImport = StopImport' Text
- newStopImport :: Text -> StopImport
- data StopImportResponse = StopImportResponse' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe ImportSource) (Maybe ImportStatistics) (Maybe ImportStatus) (Maybe POSIX) (Maybe POSIX) Int
- newStopImportResponse :: Int -> StopImportResponse
- data StopLogging = StopLogging' Text
- newStopLogging :: Text -> StopLogging
- data StopLoggingResponse = StopLoggingResponse' Int
- newStopLoggingResponse :: Int -> StopLoggingResponse
- data UpdateEventDataStore = UpdateEventDataStore' (Maybe [AdvancedEventSelector]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Bool) Text
- newUpdateEventDataStore :: Text -> UpdateEventDataStore
- data UpdateEventDataStoreResponse = UpdateEventDataStoreResponse' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe Bool) (Maybe POSIX) Int
- newUpdateEventDataStoreResponse :: Int -> UpdateEventDataStoreResponse
- data UpdateTrail = UpdateTrail' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdateTrail :: Text -> UpdateTrail
- data UpdateTrailResponse = UpdateTrailResponse' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateTrailResponse :: Int -> UpdateTrailResponse
- newtype DeliveryStatus where
- DeliveryStatus' { }
- pattern DeliveryStatus_ACCESS_DENIED :: DeliveryStatus
- pattern DeliveryStatus_ACCESS_DENIED_SIGNING_FILE :: DeliveryStatus
- pattern DeliveryStatus_CANCELLED :: DeliveryStatus
- pattern DeliveryStatus_FAILED :: DeliveryStatus
- pattern DeliveryStatus_FAILED_SIGNING_FILE :: DeliveryStatus
- pattern DeliveryStatus_PENDING :: DeliveryStatus
- pattern DeliveryStatus_RESOURCE_NOT_FOUND :: DeliveryStatus
- pattern DeliveryStatus_SUCCESS :: DeliveryStatus
- pattern DeliveryStatus_UNKNOWN :: DeliveryStatus
- newtype DestinationType where
- DestinationType' { }
- pattern DestinationType_AWS_SERVICE :: DestinationType
- pattern DestinationType_EVENT_DATA_STORE :: DestinationType
- newtype EventCategory where
- EventCategory' { }
- pattern EventCategory_Insight :: EventCategory
- newtype EventDataStoreStatus where
- newtype ImportFailureStatus where
- newtype ImportStatus where
- ImportStatus' { }
- pattern ImportStatus_COMPLETED :: ImportStatus
- pattern ImportStatus_FAILED :: ImportStatus
- pattern ImportStatus_INITIALIZING :: ImportStatus
- pattern ImportStatus_IN_PROGRESS :: ImportStatus
- pattern ImportStatus_STOPPED :: ImportStatus
- newtype InsightType where
- InsightType' { }
- pattern InsightType_ApiCallRateInsight :: InsightType
- pattern InsightType_ApiErrorRateInsight :: InsightType
- newtype LookupAttributeKey where
- LookupAttributeKey' { }
- pattern LookupAttributeKey_AccessKeyId :: LookupAttributeKey
- pattern LookupAttributeKey_EventId :: LookupAttributeKey
- pattern LookupAttributeKey_EventName :: LookupAttributeKey
- pattern LookupAttributeKey_EventSource :: LookupAttributeKey
- pattern LookupAttributeKey_ReadOnly :: LookupAttributeKey
- pattern LookupAttributeKey_ResourceName :: LookupAttributeKey
- pattern LookupAttributeKey_ResourceType :: LookupAttributeKey
- pattern LookupAttributeKey_Username :: LookupAttributeKey
- newtype QueryStatus where
- QueryStatus' { }
- pattern QueryStatus_CANCELLED :: QueryStatus
- pattern QueryStatus_FAILED :: QueryStatus
- pattern QueryStatus_FINISHED :: QueryStatus
- pattern QueryStatus_QUEUED :: QueryStatus
- pattern QueryStatus_RUNNING :: QueryStatus
- pattern QueryStatus_TIMED_OUT :: QueryStatus
- newtype ReadWriteType where
- ReadWriteType' { }
- pattern ReadWriteType_All :: ReadWriteType
- pattern ReadWriteType_ReadOnly :: ReadWriteType
- pattern ReadWriteType_WriteOnly :: ReadWriteType
- data AdvancedEventSelector = AdvancedEventSelector' (Maybe Text) (NonEmpty AdvancedFieldSelector)
- newAdvancedEventSelector :: NonEmpty AdvancedFieldSelector -> AdvancedEventSelector
- data AdvancedFieldSelector = AdvancedFieldSelector' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text
- newAdvancedFieldSelector :: Text -> AdvancedFieldSelector
- data Channel = Channel' (Maybe Text) (Maybe Text)
- newChannel :: Channel
- data DataResource = DataResource' (Maybe Text) (Maybe [Text])
- newDataResource :: DataResource
- data Destination = Destination' DestinationType Text
- newDestination :: DestinationType -> Text -> Destination
- data Event = Event' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Resource]) (Maybe Text)
- newEvent :: Event
- data EventDataStore = EventDataStore' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe Bool) (Maybe POSIX)
- newEventDataStore :: EventDataStore
- data EventSelector = EventSelector' (Maybe [DataResource]) (Maybe [Text]) (Maybe Bool) (Maybe ReadWriteType)
- newEventSelector :: EventSelector
- data ImportFailureListItem = ImportFailureListItem' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ImportFailureStatus)
- newImportFailureListItem :: ImportFailureListItem
- data ImportSource = ImportSource' S3ImportSource
- newImportSource :: S3ImportSource -> ImportSource
- data ImportStatistics = ImportStatistics' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newImportStatistics :: ImportStatistics
- data ImportsListItem = ImportsListItem' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe ImportStatus) (Maybe POSIX)
- newImportsListItem :: ImportsListItem
- data InsightSelector = InsightSelector' (Maybe InsightType)
- newInsightSelector :: InsightSelector
- data LookupAttribute = LookupAttribute' LookupAttributeKey Text
- newLookupAttribute :: LookupAttributeKey -> Text -> LookupAttribute
- data PublicKey = PublicKey' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Base64)
- newPublicKey :: PublicKey
- data Query = Query' (Maybe POSIX) (Maybe Text) (Maybe QueryStatus)
- newQuery :: Query
- data QueryStatistics = QueryStatistics' (Maybe Integer) (Maybe Int) (Maybe Int)
- newQueryStatistics :: QueryStatistics
- data QueryStatisticsForDescribeQuery = QueryStatisticsForDescribeQuery' (Maybe Integer) (Maybe POSIX) (Maybe Integer) (Maybe Integer) (Maybe Int)
- newQueryStatisticsForDescribeQuery :: QueryStatisticsForDescribeQuery
- data Resource = Resource' (Maybe Text) (Maybe Text)
- newResource :: Resource
- data ResourceTag = ResourceTag' (Maybe Text) (Maybe [Tag])
- newResourceTag :: ResourceTag
- data S3ImportSource = S3ImportSource' Text Text Text
- newS3ImportSource :: Text -> Text -> Text -> S3ImportSource
- data SourceConfig = SourceConfig' (Maybe [AdvancedEventSelector]) (Maybe Bool)
- newSourceConfig :: SourceConfig
- data Tag = Tag' (Maybe Text) Text
- newTag :: Text -> Tag
- data Trail = Trail' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newTrail :: Trail
- data TrailInfo = TrailInfo' (Maybe Text) (Maybe Text) (Maybe Text)
- newTrailInfo :: TrailInfo
Service Configuration
defaultService :: Service Source #
API version 2013-11-01
of the Amazon CloudTrail SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CloudTrail
.
AccountHasOngoingImportException
_AccountHasOngoingImportException :: AsError a => Fold a ServiceError Source #
This exception is thrown when you start a new import and a previous import is still in progress.
AccountNotFoundException
_AccountNotFoundException :: AsError a => Fold a ServiceError Source #
This exception is thrown when when the specified account is not found or not part of an organization.
AccountNotRegisteredException
_AccountNotRegisteredException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.
AccountRegisteredException
_AccountRegisteredException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the account is already registered as the CloudTrail delegated administrator.
CannotDelegateManagementAccountException
_CannotDelegateManagementAccountException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the management account of an organization is registered as the CloudTrail delegated administrator.
ChannelARNInvalidException
_ChannelARNInvalidException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the specified value of ChannelARN
is not
valid.
ChannelNotFoundException
_ChannelNotFoundException :: AsError a => Fold a ServiceError Source #
The specified channel was not found.
CloudTrailARNInvalidException
_CloudTrailARNInvalidException :: AsError a => Fold a ServiceError Source #
This exception is thrown when an operation is called with a trail ARN that is not valid. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
CloudTrailAccessNotEnabledException
_CloudTrailAccessNotEnabledException :: AsError a => Fold a ServiceError Source #
This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
CloudTrailInvalidClientTokenIdException
_CloudTrailInvalidClientTokenIdException :: AsError a => Fold a ServiceError Source #
This exception is thrown when a call results in the
InvalidClientTokenId
error code. This can occur when you are creating
or updating a trail to send notifications to an Amazon SNS topic that is
in a suspended Amazon Web Services account.
CloudWatchLogsDeliveryUnavailableException
_CloudWatchLogsDeliveryUnavailableException :: AsError a => Fold a ServiceError Source #
Cannot set a CloudWatch Logs delivery for this region.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource. If this exception occurs, wait a few minutes, and then try the operation again.
DelegatedAdminAccountLimitExceededException
_DelegatedAdminAccountLimitExceededException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the maximum number of CloudTrail delegated administrators is reached.
EventDataStoreARNInvalidException
_EventDataStoreARNInvalidException :: AsError a => Fold a ServiceError Source #
The specified event data store ARN is not valid or does not map to an event data store in your account.
EventDataStoreAlreadyExistsException
_EventDataStoreAlreadyExistsException :: AsError a => Fold a ServiceError Source #
An event data store with that name already exists.
EventDataStoreHasOngoingImportException
_EventDataStoreHasOngoingImportException :: AsError a => Fold a ServiceError Source #
This exception is thrown when you try to update or delete an event data store that currently has an import in progress.
EventDataStoreMaxLimitExceededException
_EventDataStoreMaxLimitExceededException :: AsError a => Fold a ServiceError Source #
Your account has used the maximum number of event data stores.
EventDataStoreNotFoundException
_EventDataStoreNotFoundException :: AsError a => Fold a ServiceError Source #
The specified event data store was not found.
EventDataStoreTerminationProtectedException
_EventDataStoreTerminationProtectedException :: AsError a => Fold a ServiceError Source #
The event data store cannot be deleted because termination protection is enabled for it.
ImportNotFoundException
_ImportNotFoundException :: AsError a => Fold a ServiceError Source #
The specified import was not found.
InactiveEventDataStoreException
_InactiveEventDataStoreException :: AsError a => Fold a ServiceError Source #
The event data store is inactive.
InactiveQueryException
_InactiveQueryException :: AsError a => Fold a ServiceError Source #
The specified query cannot be canceled because it is in the FINISHED
,
FAILED
, TIMED_OUT
, or CANCELLED
state.
InsightNotEnabledException
_InsightNotEnabledException :: AsError a => Fold a ServiceError Source #
If you run GetInsightSelectors
on a trail that does not have Insights
events enabled, the operation throws the exception
InsightNotEnabledException
.
InsufficientDependencyServiceAccessPermissionException
_InsufficientDependencyServiceAccessPermissionException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the IAM user or role that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
InsufficientEncryptionPolicyException
_InsufficientEncryptionPolicyException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
InsufficientS3BucketPolicyException
_InsufficientS3BucketPolicyException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the policy on the S3 bucket is not sufficient.
InsufficientSnsTopicPolicyException
_InsufficientSnsTopicPolicyException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
InvalidCloudWatchLogsLogGroupArnException
_InvalidCloudWatchLogsLogGroupArnException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the provided CloudWatch Logs log group is not valid.
InvalidCloudWatchLogsRoleArnException
_InvalidCloudWatchLogsRoleArnException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the provided role is not valid.
InvalidDateRangeException
_InvalidDateRangeException :: AsError a => Fold a ServiceError Source #
A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.
InvalidEventCategoryException
_InvalidEventCategoryException :: AsError a => Fold a ServiceError Source #
Occurs if an event category that is not valid is specified as a value of
EventCategory
.
InvalidEventDataStoreCategoryException
_InvalidEventDataStoreCategoryException :: AsError a => Fold a ServiceError Source #
This exception is thrown when event categories of specified event data stores are not valid.
InvalidEventDataStoreStatusException
_InvalidEventDataStoreStatusException :: AsError a => Fold a ServiceError Source #
The event data store is not in a status that supports the operation.
InvalidEventSelectorsException
_InvalidEventSelectorsException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the PutEventSelectors
operation is
called with a number of event selectors, advanced event selectors, or
data resources that is not valid. The combination of event selectors or
advanced event selectors and data resources is not valid. A trail can
have up to 5 event selectors. If a trail uses advanced event selectors,
a maximum of 500 total values for all conditions in all advanced event
selectors is allowed. A trail is limited to 250 data resources. These
data resources can be distributed across event selectors, but the
overall total cannot exceed 250.
You can:
- Specify a valid number of event selectors (1 to 5) for a trail.
- Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
- Specify up to 500 values for all conditions in all advanced event selectors for a trail.
- Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
InvalidHomeRegionException
_InvalidHomeRegionException :: AsError a => Fold a ServiceError Source #
This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.
InvalidImportSourceException
_InvalidImportSourceException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the provided source S3 bucket is not valid for import.
InvalidInsightSelectorsException
_InvalidInsightSelectorsException :: AsError a => Fold a ServiceError Source #
The formatting or syntax of the InsightSelectors
JSON statement in
your PutInsightSelectors
or GetInsightSelectors
request is not
valid, or the specified insight type in the InsightSelectors
statement
is not a valid insight type.
InvalidKmsKeyIdException
_InvalidKmsKeyIdException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the KMS key ARN is not valid.
InvalidLookupAttributesException
_InvalidLookupAttributesException :: AsError a => Fold a ServiceError Source #
Occurs when a lookup attribute is specified that is not valid.
InvalidMaxResultsException
_InvalidMaxResultsException :: AsError a => Fold a ServiceError Source #
This exception is thrown if the limit specified is not valid.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the combination of parameters provided is not valid.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
The request includes a parameter that is not valid.
InvalidQueryStatementException
_InvalidQueryStatementException :: AsError a => Fold a ServiceError Source #
The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.
InvalidQueryStatusException
_InvalidQueryStatusException :: AsError a => Fold a ServiceError Source #
The query status is not valid for the operation.
InvalidS3BucketNameException
_InvalidS3BucketNameException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the provided S3 bucket name is not valid.
InvalidS3PrefixException
_InvalidS3PrefixException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the provided S3 prefix is not valid.
InvalidSnsTopicNameException
_InvalidSnsTopicNameException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the provided SNS topic name is not valid.
InvalidTagParameterException
_InvalidTagParameterException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
InvalidTimeRangeException
_InvalidTimeRangeException :: AsError a => Fold a ServiceError Source #
Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
InvalidTokenException
_InvalidTokenException :: AsError a => Fold a ServiceError Source #
Reserved for future use.
InvalidTrailNameException
_InvalidTrailNameException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. - Not be in IP address format (for example, 192.168.5.4)
KmsException
_KmsException :: AsError a => Fold a ServiceError Source #
This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
KmsKeyDisabledException
_KmsKeyDisabledException :: AsError a => Fold a ServiceError Source #
This exception is no longer in use.
KmsKeyNotFoundException
_KmsKeyNotFoundException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same region.
MaxConcurrentQueriesException
_MaxConcurrentQueriesException :: AsError a => Fold a ServiceError Source #
You are already running the maximum number of concurrent queries. Wait a minute for some queries to finish, and then run the query again.
MaximumNumberOfTrailsExceededException
_MaximumNumberOfTrailsExceededException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the maximum number of trails is reached.
NoManagementAccountSLRExistsException
_NoManagementAccountSLRExistsException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the management account does not have a service-linked role.
NotOrganizationManagementAccountException
_NotOrganizationManagementAccountException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the account making the request is not the organization's management account.
NotOrganizationMasterAccountException
_NotOrganizationMasterAccountException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
OperationNotPermittedException
_OperationNotPermittedException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the requested operation is not permitted.
OrganizationNotInAllFeaturesModeException
_OrganizationNotInAllFeaturesModeException :: AsError a => Fold a ServiceError Source #
This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
OrganizationsNotInUseException
_OrganizationsNotInUseException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
QueryIdNotFoundException
_QueryIdNotFoundException :: AsError a => Fold a ServiceError Source #
The query ID does not exist or does not map to a query.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the specified resource is not found.
ResourceTypeNotSupportedException
_ResourceTypeNotSupportedException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the specified resource type is not supported by CloudTrail.
S3BucketDoesNotExistException
_S3BucketDoesNotExistException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the specified S3 bucket does not exist.
TagsLimitExceededException
_TagsLimitExceededException :: AsError a => Fold a ServiceError Source #
The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.
TrailAlreadyExistsException
_TrailAlreadyExistsException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the specified trail already exists.
TrailNotFoundException
_TrailNotFoundException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the trail with the given name is not found.
TrailNotProvidedException
_TrailNotProvidedException :: AsError a => Fold a ServiceError Source #
This exception is no longer in use.
UnsupportedOperationException
_UnsupportedOperationException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the requested operation is not supported.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AddTags
Specifies the tags to add to a trail or event data store.
See: newAddTags
smart constructor.
Instances
Create a value of AddTags
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AddTags
, addTags_resourceId
- Specifies the ARN of the trail or event data store to which one or more
tags will be added. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
AddTags
, addTags_tagsList
- Contains a list of tags, up to a limit of 50
data AddTagsResponse Source #
Returns the objects or data if successful. Otherwise, returns an error.
See: newAddTagsResponse
smart constructor.
Instances
Create a value of AddTagsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AddTagsResponse'
, addTagsResponse_httpStatus
- The response's http status code.
CancelQuery
data CancelQuery Source #
See: newCancelQuery
smart constructor.
Instances
Create a value of CancelQuery
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventDataStore:CancelQuery'
, cancelQuery_eventDataStore
- The ARN (or the ID suffix of the ARN) of an event data store on which
the specified query is running.
CancelQuery
, cancelQuery_queryId
- The ID of the query that you want to cancel. The QueryId
comes from
the response of a StartQuery
operation.
data CancelQueryResponse Source #
See: newCancelQueryResponse
smart constructor.
Instances
newCancelQueryResponse Source #
:: Int | |
-> Text | |
-> QueryStatus | |
-> CancelQueryResponse |
Create a value of CancelQueryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelQueryResponse'
, cancelQueryResponse_httpStatus
- The response's http status code.
CancelQuery
, cancelQueryResponse_queryId
- The ID of the canceled query.
CancelQueryResponse
, cancelQueryResponse_queryStatus
- Shows the status of a query after a CancelQuery
request. Typically,
the values shown are either RUNNING
or CANCELLED
.
CreateEventDataStore
data CreateEventDataStore Source #
See: newCreateEventDataStore
smart constructor.
CreateEventDataStore' (Maybe [AdvancedEventSelector]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe [Tag]) (Maybe Bool) Text |
Instances
newCreateEventDataStore Source #
Create a value of CreateEventDataStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateEventDataStore
, createEventDataStore_advancedEventSelectors
- The advanced event selectors to use to select the events for the data
store. For more information about how to use advanced event selectors,
see
Log events by using advanced event selectors
in the CloudTrail User Guide.
CreateEventDataStore
, createEventDataStore_kmsKeyId
- Specifies the KMS key ID to use to encrypt the events delivered by
CloudTrail. The value can be an alias name prefixed by alias/
, a
fully specified ARN to an alias, a fully specified ARN to a key, or a
globally unique identifier.
Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
Examples:
alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
CreateEventDataStore
, createEventDataStore_multiRegionEnabled
- Specifies whether the event data store includes events from all regions,
or only from the region in which the event data store is created.
CreateEventDataStore
, createEventDataStore_organizationEnabled
- Specifies whether an event data store collects events logged for an
organization in Organizations.
CreateEventDataStore
, createEventDataStore_retentionPeriod
- The retention period of the event data store, in days. You can set a
retention period of up to 2557 days, the equivalent of seven years.
CreateEventDataStore
, createEventDataStore_tagsList
- Undocumented member.
CreateEventDataStore
, createEventDataStore_terminationProtectionEnabled
- Specifies whether termination protection is enabled for the event data
store. If termination protection is enabled, you cannot delete the event
data store until termination protection is disabled.
CreateEventDataStore
, createEventDataStore_name
- The name of the event data store.
data CreateEventDataStoreResponse Source #
See: newCreateEventDataStoreResponse
smart constructor.
CreateEventDataStoreResponse' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe [Tag]) (Maybe Bool) (Maybe POSIX) Int |
Instances
newCreateEventDataStoreResponse Source #
Create a value of CreateEventDataStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateEventDataStore
, createEventDataStoreResponse_advancedEventSelectors
- The advanced event selectors that were used to select the events for the
data store.
CreateEventDataStoreResponse
, createEventDataStoreResponse_createdTimestamp
- The timestamp that shows when the event data store was created.
CreateEventDataStoreResponse
, createEventDataStoreResponse_eventDataStoreArn
- The ARN of the event data store.
CreateEventDataStore
, createEventDataStoreResponse_kmsKeyId
- Specifies the KMS key ID that encrypts the events delivered by
CloudTrail. The value is a fully specified ARN to a KMS key in the
following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
CreateEventDataStore
, createEventDataStoreResponse_multiRegionEnabled
- Indicates whether the event data store collects events from all regions,
or only from the region in which it was created.
CreateEventDataStore
, createEventDataStoreResponse_name
- The name of the event data store.
CreateEventDataStore
, createEventDataStoreResponse_organizationEnabled
- Indicates whether an event data store is collecting logged events for an
organization in Organizations.
CreateEventDataStore
, createEventDataStoreResponse_retentionPeriod
- The retention period of an event data store, in days.
CreateEventDataStoreResponse
, createEventDataStoreResponse_status
- The status of event data store creation.
CreateEventDataStore
, createEventDataStoreResponse_tagsList
- Undocumented member.
CreateEventDataStore
, createEventDataStoreResponse_terminationProtectionEnabled
- Indicates whether termination protection is enabled for the event data
store.
CreateEventDataStoreResponse
, createEventDataStoreResponse_updatedTimestamp
- The timestamp that shows when an event data store was updated, if
applicable. UpdatedTimestamp
is always either the same or newer than
the time shown in CreatedTimestamp
.
$sel:httpStatus:CreateEventDataStoreResponse'
, createEventDataStoreResponse_httpStatus
- The response's http status code.
CreateTrail
data CreateTrail Source #
Specifies the settings for each trail.
See: newCreateTrail
smart constructor.
CreateTrail' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text |
Instances
Create a value of CreateTrail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateTrail
, createTrail_cloudWatchLogsLogGroupArn
- Specifies a log group name using an Amazon Resource Name (ARN), a unique
identifier that represents the log group to which CloudTrail logs will
be delivered. Not required unless you specify CloudWatchLogsRoleArn
.
CreateTrail
, createTrail_cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to write
to a user's log group.
$sel:enableLogFileValidation:CreateTrail'
, createTrail_enableLogFileValidation
- Specifies whether log file integrity validation is enabled. The default
is false.
When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
CreateTrail
, createTrail_includeGlobalServiceEvents
- Specifies whether the trail is publishing events from global services
such as IAM to the log files.
CreateTrail
, createTrail_isMultiRegionTrail
- Specifies whether the trail is created in the current region or in all
regions. The default is false, which creates a trail only in the region
where you are signed in. As a best practice, consider creating trails
that log events in all regions.
CreateTrail
, createTrail_isOrganizationTrail
- Specifies whether the trail is created for all accounts in an
organization in Organizations, or only for the current Amazon Web
Services account. The default is false, and cannot be true unless the
call is made on behalf of an Amazon Web Services account that is the
management account for an organization in Organizations.
CreateTrail
, createTrail_kmsKeyId
- Specifies the KMS key ID to use to encrypt the logs delivered by
CloudTrail. The value can be an alias name prefixed by alias/
, a
fully specified ARN to an alias, a fully specified ARN to a key, or a
globally unique identifier.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
Examples:
alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
CreateTrail
, createTrail_s3KeyPrefix
- Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery. For more information,
see
Finding Your CloudTrail Log Files.
The maximum length is 200 characters.
CreateTrail
, createTrail_snsTopicName
- Specifies the name of the Amazon SNS topic defined for notification of
log file delivery. The maximum length is 256 characters.
CreateTrail
, createTrail_tagsList
- Undocumented member.
CreateTrail
, createTrail_name
- Specifies the name of the trail. The name must meet the following
requirements:
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. - Not be in IP address format (for example, 192.168.5.4)
CreateTrail
, createTrail_s3BucketName
- Specifies the name of the Amazon S3 bucket designated for publishing log
files. See
Amazon S3 Bucket Naming Requirements.
data CreateTrailResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newCreateTrailResponse
smart constructor.
CreateTrailResponse' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCreateTrailResponse Source #
Create a value of CreateTrailResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateTrail
, createTrailResponse_cloudWatchLogsLogGroupArn
- Specifies the Amazon Resource Name (ARN) of the log group to which
CloudTrail logs will be delivered.
CreateTrail
, createTrailResponse_cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to write
to a user's log group.
CreateTrail
, createTrailResponse_includeGlobalServiceEvents
- Specifies whether the trail is publishing events from global services
such as IAM to the log files.
CreateTrail
, createTrailResponse_isMultiRegionTrail
- Specifies whether the trail exists in one region or in all regions.
CreateTrail
, createTrailResponse_isOrganizationTrail
- Specifies whether the trail is an organization trail.
CreateTrail
, createTrailResponse_kmsKeyId
- Specifies the KMS key ID that encrypts the events delivered by
CloudTrail. The value is a fully specified ARN to a KMS key in the
following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
CreateTrailResponse
, createTrailResponse_logFileValidationEnabled
- Specifies whether log file integrity validation is enabled.
CreateTrail
, createTrailResponse_name
- Specifies the name of the trail.
CreateTrail
, createTrailResponse_s3BucketName
- Specifies the name of the Amazon S3 bucket designated for publishing log
files.
CreateTrail
, createTrailResponse_s3KeyPrefix
- Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery. For more information,
see
Finding Your CloudTrail Log Files.
CreateTrailResponse
, createTrailResponse_snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
notifications when log files are delivered. The format of a topic ARN
is:
arn:aws:sns:us-east-2:123456789012:MyTopic
CreateTrail
, createTrailResponse_snsTopicName
- This field is no longer in use. Use SnsTopicARN.
CreateTrailResponse
, createTrailResponse_trailARN
- Specifies the ARN of the trail that was created. The format of a trail
ARN is:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
$sel:httpStatus:CreateTrailResponse'
, createTrailResponse_httpStatus
- The response's http status code.
DeleteEventDataStore
data DeleteEventDataStore Source #
See: newDeleteEventDataStore
smart constructor.
Instances
newDeleteEventDataStore Source #
Create a value of DeleteEventDataStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventDataStore:DeleteEventDataStore'
, deleteEventDataStore_eventDataStore
- The ARN (or the ID suffix of the ARN) of the event data store to delete.
data DeleteEventDataStoreResponse Source #
See: newDeleteEventDataStoreResponse
smart constructor.
Instances
newDeleteEventDataStoreResponse Source #
Create a value of DeleteEventDataStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEventDataStoreResponse'
, deleteEventDataStoreResponse_httpStatus
- The response's http status code.
DeleteTrail
data DeleteTrail Source #
The request that specifies the name of a trail to delete.
See: newDeleteTrail
smart constructor.
Instances
Create a value of DeleteTrail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteTrail
, deleteTrail_name
- Specifies the name or the CloudTrail ARN of the trail to be deleted. The
following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
data DeleteTrailResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newDeleteTrailResponse
smart constructor.
Instances
newDeleteTrailResponse Source #
Create a value of DeleteTrailResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteTrailResponse'
, deleteTrailResponse_httpStatus
- The response's http status code.
DeregisterOrganizationDelegatedAdmin
data DeregisterOrganizationDelegatedAdmin Source #
Removes CloudTrail delegated administrator permissions from a specified member account in an organization that is currently designated as a delegated administrator.
See: newDeregisterOrganizationDelegatedAdmin
smart constructor.
Instances
newDeregisterOrganizationDelegatedAdmin Source #
:: Text |
|
-> DeregisterOrganizationDelegatedAdmin |
Create a value of DeregisterOrganizationDelegatedAdmin
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:delegatedAdminAccountId:DeregisterOrganizationDelegatedAdmin'
, deregisterOrganizationDelegatedAdmin_delegatedAdminAccountId
- A delegated administrator account ID. This is a member account in an
organization that is currently designated as a delegated administrator.
data DeregisterOrganizationDelegatedAdminResponse Source #
Returns the following response if successful. Otherwise, returns an error.
See: newDeregisterOrganizationDelegatedAdminResponse
smart constructor.
Instances
Generic DeregisterOrganizationDelegatedAdminResponse Source # | |
Read DeregisterOrganizationDelegatedAdminResponse Source # | |
Show DeregisterOrganizationDelegatedAdminResponse Source # | |
NFData DeregisterOrganizationDelegatedAdminResponse Source # | |
Eq DeregisterOrganizationDelegatedAdminResponse Source # | |
type Rep DeregisterOrganizationDelegatedAdminResponse Source # | |
Defined in Amazonka.CloudTrail.DeregisterOrganizationDelegatedAdmin type Rep DeregisterOrganizationDelegatedAdminResponse = D1 ('MetaData "DeregisterOrganizationDelegatedAdminResponse" "Amazonka.CloudTrail.DeregisterOrganizationDelegatedAdmin" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "DeregisterOrganizationDelegatedAdminResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeregisterOrganizationDelegatedAdminResponse Source #
:: Int |
|
-> DeregisterOrganizationDelegatedAdminResponse |
Create a value of DeregisterOrganizationDelegatedAdminResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeregisterOrganizationDelegatedAdminResponse'
, deregisterOrganizationDelegatedAdminResponse_httpStatus
- The response's http status code.
DescribeQuery
data DescribeQuery Source #
See: newDescribeQuery
smart constructor.
Instances
Create a value of DescribeQuery
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventDataStore:DescribeQuery'
, describeQuery_eventDataStore
- The ARN (or the ID suffix of the ARN) of an event data store on which
the specified query was run.
DescribeQuery
, describeQuery_queryId
- The query ID.
data DescribeQueryResponse Source #
See: newDescribeQueryResponse
smart constructor.
DescribeQueryResponse' (Maybe Text) (Maybe DeliveryStatus) (Maybe Text) (Maybe Text) (Maybe QueryStatisticsForDescribeQuery) (Maybe QueryStatus) (Maybe Text) Int |
Instances
newDescribeQueryResponse Source #
Create a value of DescribeQueryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deliveryS3Uri:DescribeQueryResponse'
, describeQueryResponse_deliveryS3Uri
- The URI for the S3 bucket where CloudTrail delivered query results, if
applicable.
$sel:deliveryStatus:DescribeQueryResponse'
, describeQueryResponse_deliveryStatus
- The delivery status.
DescribeQueryResponse
, describeQueryResponse_errorMessage
- The error message returned if a query failed.
DescribeQuery
, describeQueryResponse_queryId
- The ID of the query.
$sel:queryStatistics:DescribeQueryResponse'
, describeQueryResponse_queryStatistics
- Metadata about a query, including the number of events that were
matched, the total number of events scanned, the query run time in
milliseconds, and the query's creation time.
DescribeQueryResponse
, describeQueryResponse_queryStatus
- The status of a query. Values for QueryStatus
include QUEUED
,
RUNNING
, FINISHED
, FAILED
, TIMED_OUT
, or CANCELLED
$sel:queryString:DescribeQueryResponse'
, describeQueryResponse_queryString
- The SQL code of a query.
$sel:httpStatus:DescribeQueryResponse'
, describeQueryResponse_httpStatus
- The response's http status code.
DescribeTrails
data DescribeTrails Source #
Returns information about the trail.
See: newDescribeTrails
smart constructor.
DescribeTrails' (Maybe Bool) (Maybe [Text]) |
Instances
newDescribeTrails :: DescribeTrails Source #
Create a value of DescribeTrails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeShadowTrails:DescribeTrails'
, describeTrails_includeShadowTrails
- Specifies whether to include shadow trails in the response. A shadow
trail is the replication in a region of a trail that was created in a
different region, or in the case of an organization trail, the
replication of an organization trail in member accounts. If you do not
include shadow trails, organization trails in a member account and
region replication trails will not be returned. The default is true.
$sel:trailNameList:DescribeTrails'
, describeTrails_trailNameList
- Specifies a list of trail names, trail ARNs, or both, of the trails to
describe. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
If an empty list is specified, information for the trail in the current region is returned.
- If an empty list is specified and
IncludeShadowTrails
is false, then information for all trails in the current region is returned. - If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.
If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.
data DescribeTrailsResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newDescribeTrailsResponse
smart constructor.
Instances
newDescribeTrailsResponse Source #
Create a value of DescribeTrailsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trailList:DescribeTrailsResponse'
, describeTrailsResponse_trailList
- The list of trail objects. Trail objects with string values are only
returned if values for the objects exist in a trail's configuration.
For example, SNSTopicName
and SNSTopicARN
are only returned in
results if a trail is configured to send SNS notifications. Similarly,
KMSKeyId
only appears in results if a trail's log files are encrypted
with KMS customer managed keys.
$sel:httpStatus:DescribeTrailsResponse'
, describeTrailsResponse_httpStatus
- The response's http status code.
GetChannel
data GetChannel Source #
See: newGetChannel
smart constructor.
Instances
Create a value of GetChannel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channel:GetChannel'
, getChannel_channel
- The ARN or UUID
of a channel.
data GetChannelResponse Source #
See: newGetChannelResponse
smart constructor.
GetChannelResponse' (Maybe Text) (Maybe (NonEmpty Destination)) (Maybe Text) (Maybe Text) (Maybe SourceConfig) Int |
Instances
newGetChannelResponse Source #
Create a value of GetChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetChannelResponse
, getChannelResponse_channelArn
- The ARN of an channel returned by a GetChannel
request.
GetChannelResponse
, getChannelResponse_destinations
- The Amazon Web Services service that created the service-linked channel.
GetChannelResponse
, getChannelResponse_name
- The name of the CloudTrail channel. For service-linked channels, the
value is aws-service-channel/service-name/custom-suffix
where
service-name
represents the name of the Amazon Web Services service
that created the channel and custom-suffix
represents the suffix
generated by the Amazon Web Services service.
$sel:source:GetChannelResponse'
, getChannelResponse_source
- The event source for the CloudTrail channel.
$sel:sourceConfig:GetChannelResponse'
, getChannelResponse_sourceConfig
- Provides information about the advanced event selectors configured for
the channel, and whether the channel applies to all regions or a single
region.
$sel:httpStatus:GetChannelResponse'
, getChannelResponse_httpStatus
- The response's http status code.
GetEventDataStore
data GetEventDataStore Source #
See: newGetEventDataStore
smart constructor.
Instances
Create a value of GetEventDataStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventDataStore:GetEventDataStore'
, getEventDataStore_eventDataStore
- The ARN (or ID suffix of the ARN) of the event data store about which
you want information.
data GetEventDataStoreResponse Source #
See: newGetEventDataStoreResponse
smart constructor.
GetEventDataStoreResponse' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe Bool) (Maybe POSIX) Int |
Instances
newGetEventDataStoreResponse Source #
Create a value of GetEventDataStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEventDataStoreResponse
, getEventDataStoreResponse_advancedEventSelectors
- The advanced event selectors used to select events for the data store.
GetEventDataStoreResponse
, getEventDataStoreResponse_createdTimestamp
- The timestamp of the event data store's creation.
GetEventDataStoreResponse
, getEventDataStoreResponse_eventDataStoreArn
- The event data store Amazon Resource Number (ARN).
GetEventDataStoreResponse
, getEventDataStoreResponse_kmsKeyId
- Specifies the KMS key ID that encrypts the events delivered by
CloudTrail. The value is a fully specified ARN to a KMS key in the
following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
GetEventDataStoreResponse
, getEventDataStoreResponse_multiRegionEnabled
- Indicates whether the event data store includes events from all regions,
or only from the region in which it was created.
GetEventDataStoreResponse
, getEventDataStoreResponse_name
- The name of the event data store.
GetEventDataStoreResponse
, getEventDataStoreResponse_organizationEnabled
- Indicates whether an event data store is collecting logged events for an
organization in Organizations.
GetEventDataStoreResponse
, getEventDataStoreResponse_retentionPeriod
- The retention period of the event data store, in days.
GetEventDataStoreResponse
, getEventDataStoreResponse_status
- The status of an event data store. Values can be ENABLED
and
PENDING_DELETION
.
GetEventDataStoreResponse
, getEventDataStoreResponse_terminationProtectionEnabled
- Indicates that termination protection is enabled.
GetEventDataStoreResponse
, getEventDataStoreResponse_updatedTimestamp
- Shows the time that an event data store was updated, if applicable.
UpdatedTimestamp
is always either the same or newer than the time
shown in CreatedTimestamp
.
$sel:httpStatus:GetEventDataStoreResponse'
, getEventDataStoreResponse_httpStatus
- The response's http status code.
GetEventSelectors
data GetEventSelectors Source #
See: newGetEventSelectors
smart constructor.
Instances
Create a value of GetEventSelectors
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trailName:GetEventSelectors'
, getEventSelectors_trailName
- Specifies the name of the trail or trail ARN. If you specify a trail
name, the string must meet the following requirements:
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. - Not be in IP address format (for example, 192.168.5.4)
If you specify a trail ARN, it must be in the format:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
data GetEventSelectorsResponse Source #
See: newGetEventSelectorsResponse
smart constructor.
Instances
newGetEventSelectorsResponse Source #
Create a value of GetEventSelectorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEventSelectorsResponse
, getEventSelectorsResponse_advancedEventSelectors
- The advanced event selectors that are configured for the trail.
$sel:eventSelectors:GetEventSelectorsResponse'
, getEventSelectorsResponse_eventSelectors
- The event selectors that are configured for the trail.
GetEventSelectorsResponse
, getEventSelectorsResponse_trailARN
- The specified trail ARN that has the event selectors.
$sel:httpStatus:GetEventSelectorsResponse'
, getEventSelectorsResponse_httpStatus
- The response's http status code.
GetImport
See: newGetImport
smart constructor.
Instances
Create a value of GetImport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetImport
, getImport_importId
- The ID for the import.
data GetImportResponse Source #
See: newGetImportResponse
smart constructor.
GetImportResponse' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe ImportSource) (Maybe ImportStatistics) (Maybe ImportStatus) (Maybe POSIX) (Maybe POSIX) Int |
Instances
Create a value of GetImportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetImportResponse
, getImportResponse_createdTimestamp
- The timestamp of the import's creation.
GetImportResponse
, getImportResponse_destinations
- The ARN of the destination event data store.
$sel:endEventTime:GetImportResponse'
, getImportResponse_endEventTime
- Used with StartEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period.
GetImport
, getImportResponse_importId
- The ID of the import.
$sel:importSource:GetImportResponse'
, getImportResponse_importSource
- The source S3 bucket.
$sel:importStatistics:GetImportResponse'
, getImportResponse_importStatistics
- Provides statistics for the import. CloudTrail does not update import
statistics in real-time. Returned values for parameters such as
EventsCompleted
may be lower than the actual value, because CloudTrail
updates statistics incrementally over the course of the import.
GetImportResponse
, getImportResponse_importStatus
- The status of the import.
$sel:startEventTime:GetImportResponse'
, getImportResponse_startEventTime
- Used with EndEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period.
GetImportResponse
, getImportResponse_updatedTimestamp
- The timestamp of when the import was updated.
$sel:httpStatus:GetImportResponse'
, getImportResponse_httpStatus
- The response's http status code.
GetInsightSelectors
data GetInsightSelectors Source #
See: newGetInsightSelectors
smart constructor.
Instances
newGetInsightSelectors Source #
Create a value of GetInsightSelectors
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trailName:GetInsightSelectors'
, getInsightSelectors_trailName
- Specifies the name of the trail or trail ARN. If you specify a trail
name, the string must meet the following requirements:
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. - Not be in IP address format (for example, 192.168.5.4)
If you specify a trail ARN, it must be in the format:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
data GetInsightSelectorsResponse Source #
See: newGetInsightSelectorsResponse
smart constructor.
Instances
newGetInsightSelectorsResponse Source #
Create a value of GetInsightSelectorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:insightSelectors:GetInsightSelectorsResponse'
, getInsightSelectorsResponse_insightSelectors
- A JSON string that contains the insight types you want to log on a
trail. In this release, ApiErrorRateInsight
and ApiCallRateInsight
are supported as insight types.
GetInsightSelectorsResponse
, getInsightSelectorsResponse_trailARN
- The Amazon Resource Name (ARN) of a trail for which you want to get
Insights selectors.
$sel:httpStatus:GetInsightSelectorsResponse'
, getInsightSelectorsResponse_httpStatus
- The response's http status code.
GetQueryResults
data GetQueryResults Source #
See: newGetQueryResults
smart constructor.
Instances
Create a value of GetQueryResults
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventDataStore:GetQueryResults'
, getQueryResults_eventDataStore
- The ARN (or ID suffix of the ARN) of the event data store against which
the query was run.
$sel:maxQueryResults:GetQueryResults'
, getQueryResults_maxQueryResults
- The maximum number of query results to display on a single page.
GetQueryResults
, getQueryResults_nextToken
- A token you can use to get the next page of query results.
GetQueryResults
, getQueryResults_queryId
- The ID of the query for which you want to get results.
data GetQueryResultsResponse Source #
See: newGetQueryResultsResponse
smart constructor.
GetQueryResultsResponse' (Maybe Text) (Maybe Text) (Maybe [[HashMap Text Text]]) (Maybe QueryStatistics) (Maybe QueryStatus) Int |
Instances
newGetQueryResultsResponse Source #
Create a value of GetQueryResultsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetQueryResultsResponse
, getQueryResultsResponse_errorMessage
- The error message returned if a query failed.
GetQueryResults
, getQueryResultsResponse_nextToken
- A token you can use to get the next page of query results.
$sel:queryResultRows:GetQueryResultsResponse'
, getQueryResultsResponse_queryResultRows
- Contains the individual event results of the query.
$sel:queryStatistics:GetQueryResultsResponse'
, getQueryResultsResponse_queryStatistics
- Shows the count of query results.
GetQueryResultsResponse
, getQueryResultsResponse_queryStatus
- The status of the query. Values include QUEUED
, RUNNING
, FINISHED
,
FAILED
, TIMED_OUT
, or CANCELLED
.
$sel:httpStatus:GetQueryResultsResponse'
, getQueryResultsResponse_httpStatus
- The response's http status code.
GetTrail
See: newGetTrail
smart constructor.
Instances
Create a value of GetTrail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTrail
, getTrail_name
- The name or the Amazon Resource Name (ARN) of the trail for which you
want to retrieve settings information.
data GetTrailResponse Source #
See: newGetTrailResponse
smart constructor.
Instances
Create a value of GetTrailResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trail:GetTrailResponse'
, getTrailResponse_trail
- Undocumented member.
$sel:httpStatus:GetTrailResponse'
, getTrailResponse_httpStatus
- The response's http status code.
GetTrailStatus
data GetTrailStatus Source #
The name of a trail about which you want the current status.
See: newGetTrailStatus
smart constructor.
Instances
Create a value of GetTrailStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTrailStatus
, getTrailStatus_name
- Specifies the name or the CloudTrail ARN of the trail for which you are
requesting status. To get the status of a shadow trail (a replication of
the trail in another region), you must specify its ARN. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
data GetTrailStatusResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newGetTrailStatusResponse
smart constructor.
GetTrailStatusResponse' (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) Int |
Instances
newGetTrailStatusResponse Source #
Create a value of GetTrailStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isLogging:GetTrailStatusResponse'
, getTrailStatusResponse_isLogging
- Whether the CloudTrail trail is currently logging Amazon Web Services
API calls.
$sel:latestCloudWatchLogsDeliveryError:GetTrailStatusResponse'
, getTrailStatusResponse_latestCloudWatchLogsDeliveryError
- Displays any CloudWatch Logs error that CloudTrail encountered when
attempting to deliver logs to CloudWatch Logs.
$sel:latestCloudWatchLogsDeliveryTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestCloudWatchLogsDeliveryTime
- Displays the most recent date and time when CloudTrail delivered logs to
CloudWatch Logs.
$sel:latestDeliveryAttemptSucceeded:GetTrailStatusResponse'
, getTrailStatusResponse_latestDeliveryAttemptSucceeded
- This field is no longer in use.
$sel:latestDeliveryAttemptTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestDeliveryAttemptTime
- This field is no longer in use.
$sel:latestDeliveryError:GetTrailStatusResponse'
, getTrailStatusResponse_latestDeliveryError
- Displays any Amazon S3 error that CloudTrail encountered when attempting
to deliver log files to the designated bucket. For more information, see
Error Responses
in the Amazon S3 API Reference.
This error occurs only when there is a problem with the destination S3
bucket, and does not occur for requests that time out. To resolve the
issue, create a new bucket, and then call UpdateTrail
to specify the
new bucket; or fix the existing objects so that CloudTrail can again
write to the bucket.
$sel:latestDeliveryTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestDeliveryTime
- Specifies the date and time that CloudTrail last delivered log files to
an account's Amazon S3 bucket.
$sel:latestDigestDeliveryError:GetTrailStatusResponse'
, getTrailStatusResponse_latestDigestDeliveryError
- Displays any Amazon S3 error that CloudTrail encountered when attempting
to deliver a digest file to the designated bucket. For more information,
see
Error Responses
in the Amazon S3 API Reference.
This error occurs only when there is a problem with the destination S3
bucket, and does not occur for requests that time out. To resolve the
issue, create a new bucket, and then call UpdateTrail
to specify the
new bucket; or fix the existing objects so that CloudTrail can again
write to the bucket.
$sel:latestDigestDeliveryTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestDigestDeliveryTime
- Specifies the date and time that CloudTrail last delivered a digest file
to an account's Amazon S3 bucket.
$sel:latestNotificationAttemptSucceeded:GetTrailStatusResponse'
, getTrailStatusResponse_latestNotificationAttemptSucceeded
- This field is no longer in use.
$sel:latestNotificationAttemptTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestNotificationAttemptTime
- This field is no longer in use.
$sel:latestNotificationError:GetTrailStatusResponse'
, getTrailStatusResponse_latestNotificationError
- Displays any Amazon SNS error that CloudTrail encountered when
attempting to send a notification. For more information about Amazon SNS
errors, see the
Amazon SNS Developer Guide.
$sel:latestNotificationTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestNotificationTime
- Specifies the date and time of the most recent Amazon SNS notification
that CloudTrail has written a new log file to an account's Amazon S3
bucket.
$sel:startLoggingTime:GetTrailStatusResponse'
, getTrailStatusResponse_startLoggingTime
- Specifies the most recent date and time when CloudTrail started
recording API calls for an Amazon Web Services account.
$sel:stopLoggingTime:GetTrailStatusResponse'
, getTrailStatusResponse_stopLoggingTime
- Specifies the most recent date and time when CloudTrail stopped
recording API calls for an Amazon Web Services account.
$sel:timeLoggingStarted:GetTrailStatusResponse'
, getTrailStatusResponse_timeLoggingStarted
- This field is no longer in use.
$sel:timeLoggingStopped:GetTrailStatusResponse'
, getTrailStatusResponse_timeLoggingStopped
- This field is no longer in use.
$sel:httpStatus:GetTrailStatusResponse'
, getTrailStatusResponse_httpStatus
- The response's http status code.
ListChannels
data ListChannels Source #
See: newListChannels
smart constructor.
Instances
newListChannels :: ListChannels Source #
Create a value of ListChannels
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListChannels'
, listChannels_maxResults
- The maximum number of CloudTrail channels to display on a single page.
ListChannels
, listChannels_nextToken
- The token to use to get the next page of results after a previous API
call. This token must be passed in with the same parameters that were
specified in the original call. For example, if the original call
specified an AttributeKey of 'Username' with a value of 'root', the
call with NextToken should include those same parameters.
data ListChannelsResponse Source #
See: newListChannelsResponse
smart constructor.
Instances
newListChannelsResponse Source #
Create a value of ListChannelsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channels:ListChannelsResponse'
, listChannelsResponse_channels
- The list of channels in the account.
ListChannels
, listChannelsResponse_nextToken
- The token to use to get the next page of results after a previous API
call.
$sel:httpStatus:ListChannelsResponse'
, listChannelsResponse_httpStatus
- The response's http status code.
ListEventDataStores
data ListEventDataStores Source #
See: newListEventDataStores
smart constructor.
Instances
newListEventDataStores :: ListEventDataStores Source #
Create a value of ListEventDataStores
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListEventDataStores'
, listEventDataStores_maxResults
- The maximum number of event data stores to display on a single page.
ListEventDataStores
, listEventDataStores_nextToken
- A token you can use to get the next page of event data store results.
data ListEventDataStoresResponse Source #
See: newListEventDataStoresResponse
smart constructor.
Instances
newListEventDataStoresResponse Source #
Create a value of ListEventDataStoresResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventDataStores:ListEventDataStoresResponse'
, listEventDataStoresResponse_eventDataStores
- Contains information about event data stores in the account, in the
current region.
ListEventDataStores
, listEventDataStoresResponse_nextToken
- A token you can use to get the next page of results.
$sel:httpStatus:ListEventDataStoresResponse'
, listEventDataStoresResponse_httpStatus
- The response's http status code.
ListImportFailures (Paginated)
data ListImportFailures Source #
See: newListImportFailures
smart constructor.
Instances
newListImportFailures Source #
Create a value of ListImportFailures
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListImportFailures'
, listImportFailures_maxResults
- The maximum number of failures to display on a single page.
ListImportFailures
, listImportFailures_nextToken
- A token you can use to get the next page of import failures.
ListImportFailures
, listImportFailures_importId
- The ID of the import.
data ListImportFailuresResponse Source #
See: newListImportFailuresResponse
smart constructor.
Instances
newListImportFailuresResponse Source #
Create a value of ListImportFailuresResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failures:ListImportFailuresResponse'
, listImportFailuresResponse_failures
- Contains information about the import failures.
ListImportFailures
, listImportFailuresResponse_nextToken
- A token you can use to get the next page of results.
$sel:httpStatus:ListImportFailuresResponse'
, listImportFailuresResponse_httpStatus
- The response's http status code.
ListImports (Paginated)
data ListImports Source #
See: newListImports
smart constructor.
ListImports' (Maybe Text) (Maybe ImportStatus) (Maybe Natural) (Maybe Text) |
Instances
newListImports :: ListImports Source #
Create a value of ListImports
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destination:ListImports'
, listImports_destination
- The ARN of the destination event data store.
ListImports
, listImports_importStatus
- The status of the import.
$sel:maxResults:ListImports'
, listImports_maxResults
- The maximum number of imports to display on a single page.
ListImports
, listImports_nextToken
- A token you can use to get the next page of import results.
data ListImportsResponse Source #
See: newListImportsResponse
smart constructor.
Instances
newListImportsResponse Source #
Create a value of ListImportsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imports:ListImportsResponse'
, listImportsResponse_imports
- The list of returned imports.
ListImports
, listImportsResponse_nextToken
- A token you can use to get the next page of import results.
$sel:httpStatus:ListImportsResponse'
, listImportsResponse_httpStatus
- The response's http status code.
ListPublicKeys (Paginated)
data ListPublicKeys Source #
Requests the public keys for a specified time range.
See: newListPublicKeys
smart constructor.
Instances
newListPublicKeys :: ListPublicKeys Source #
Create a value of ListPublicKeys
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:ListPublicKeys'
, listPublicKeys_endTime
- Optionally specifies, in UTC, the end of the time range to look up
public keys for CloudTrail digest files. If not specified, the current
time is used.
ListPublicKeys
, listPublicKeys_nextToken
- Reserved for future use.
$sel:startTime:ListPublicKeys'
, listPublicKeys_startTime
- Optionally specifies, in UTC, the start of the time range to look up
public keys for CloudTrail digest files. If not specified, the current
time is used, and the current public key is returned.
data ListPublicKeysResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newListPublicKeysResponse
smart constructor.
Instances
newListPublicKeysResponse Source #
Create a value of ListPublicKeysResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPublicKeys
, listPublicKeysResponse_nextToken
- Reserved for future use.
$sel:publicKeyList:ListPublicKeysResponse'
, listPublicKeysResponse_publicKeyList
- Contains an array of PublicKey objects.
The returned public keys may have validity time ranges that overlap.
$sel:httpStatus:ListPublicKeysResponse'
, listPublicKeysResponse_httpStatus
- The response's http status code.
ListQueries
data ListQueries Source #
See: newListQueries
smart constructor.
Instances
Create a value of ListQueries
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:ListQueries'
, listQueries_endTime
- Use with StartTime
to bound a ListQueries
request, and limit its
results to only those queries run within a specified time period.
$sel:maxResults:ListQueries'
, listQueries_maxResults
- The maximum number of queries to show on a page.
ListQueries
, listQueries_nextToken
- A token you can use to get the next page of results.
ListQueries
, listQueries_queryStatus
- The status of queries that you want to return in results. Valid values
for QueryStatus
include QUEUED
, RUNNING
, FINISHED
, FAILED
,
TIMED_OUT
, or CANCELLED
.
$sel:startTime:ListQueries'
, listQueries_startTime
- Use with EndTime
to bound a ListQueries
request, and limit its
results to only those queries run within a specified time period.
$sel:eventDataStore:ListQueries'
, listQueries_eventDataStore
- The ARN (or the ID suffix of the ARN) of an event data store on which
queries were run.
data ListQueriesResponse Source #
See: newListQueriesResponse
smart constructor.
Instances
newListQueriesResponse Source #
Create a value of ListQueriesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListQueries
, listQueriesResponse_nextToken
- A token you can use to get the next page of results.
$sel:queries:ListQueriesResponse'
, listQueriesResponse_queries
- Lists matching query results, and shows query ID, status, and creation
time of each query.
$sel:httpStatus:ListQueriesResponse'
, listQueriesResponse_httpStatus
- The response's http status code.
ListTags (Paginated)
Specifies a list of tags to return.
See: newListTags
smart constructor.
Instances
newListTags :: ListTags Source #
Create a value of ListTags
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTags
, listTags_nextToken
- Reserved for future use.
$sel:resourceIdList:ListTags'
, listTags_resourceIdList
- Specifies a list of trail and event data store ARNs whose tags will be
listed. The list has a limit of 20 ARNs.
data ListTagsResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newListTagsResponse
smart constructor.
Instances
Create a value of ListTagsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTags
, listTagsResponse_nextToken
- Reserved for future use.
$sel:resourceTagList:ListTagsResponse'
, listTagsResponse_resourceTagList
- A list of resource tags.
$sel:httpStatus:ListTagsResponse'
, listTagsResponse_httpStatus
- The response's http status code.
ListTrails (Paginated)
data ListTrails Source #
See: newListTrails
smart constructor.
Instances
newListTrails :: ListTrails Source #
Create a value of ListTrails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTrails
, listTrails_nextToken
- The token to use to get the next page of results after a previous API
call. This token must be passed in with the same parameters that were
specified in the original call. For example, if the original call
specified an AttributeKey of 'Username' with a value of 'root', the
call with NextToken should include those same parameters.
data ListTrailsResponse Source #
See: newListTrailsResponse
smart constructor.
Instances
newListTrailsResponse Source #
Create a value of ListTrailsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTrails
, listTrailsResponse_nextToken
- The token to use to get the next page of results after a previous API
call. If the token does not appear, there are no more results to return.
The token must be passed in with the same parameters as the previous
call. For example, if the original call specified an AttributeKey of
'Username' with a value of 'root', the call with NextToken should
include those same parameters.
$sel:trails:ListTrailsResponse'
, listTrailsResponse_trails
- Returns the name, ARN, and home region of trails in the current account.
$sel:httpStatus:ListTrailsResponse'
, listTrailsResponse_httpStatus
- The response's http status code.
LookupEvents (Paginated)
data LookupEvents Source #
Contains a request for LookupEvents.
See: newLookupEvents
smart constructor.
LookupEvents' (Maybe POSIX) (Maybe EventCategory) (Maybe [LookupAttribute]) (Maybe Natural) (Maybe Text) (Maybe POSIX) |
Instances
newLookupEvents :: LookupEvents Source #
Create a value of LookupEvents
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:LookupEvents'
, lookupEvents_endTime
- Specifies that only events that occur before or at the specified time
are returned. If the specified end time is before the specified start
time, an error is returned.
$sel:eventCategory:LookupEvents'
, lookupEvents_eventCategory
- Specifies the event category. If you do not specify an event category,
events of the category are not returned in the response. For example, if
you do not specify insight
as the value of EventCategory
, no
Insights events are returned.
$sel:lookupAttributes:LookupEvents'
, lookupEvents_lookupAttributes
- Contains a list of lookup attributes. Currently the list can contain
only one item.
$sel:maxResults:LookupEvents'
, lookupEvents_maxResults
- The number of events to return. Possible values are 1 through 50. The
default is 50.
LookupEvents
, lookupEvents_nextToken
- The token to use to get the next page of results after a previous API
call. This token must be passed in with the same parameters that were
specified in the original call. For example, if the original call
specified an AttributeKey of 'Username' with a value of 'root', the
call with NextToken should include those same parameters.
$sel:startTime:LookupEvents'
, lookupEvents_startTime
- Specifies that only events that occur after or at the specified time are
returned. If the specified start time is after the specified end time,
an error is returned.
data LookupEventsResponse Source #
Contains a response to a LookupEvents action.
See: newLookupEventsResponse
smart constructor.
Instances
newLookupEventsResponse Source #
Create a value of LookupEventsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:events:LookupEventsResponse'
, lookupEventsResponse_events
- A list of events returned based on the lookup attributes specified and
the CloudTrail event. The events list is sorted by time. The most recent
event is listed first.
LookupEvents
, lookupEventsResponse_nextToken
- The token to use to get the next page of results after a previous API
call. If the token does not appear, there are no more results to return.
The token must be passed in with the same parameters as the previous
call. For example, if the original call specified an AttributeKey of
'Username' with a value of 'root', the call with NextToken should
include those same parameters.
$sel:httpStatus:LookupEventsResponse'
, lookupEventsResponse_httpStatus
- The response's http status code.
PutEventSelectors
data PutEventSelectors Source #
See: newPutEventSelectors
smart constructor.
Instances
Create a value of PutEventSelectors
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutEventSelectors
, putEventSelectors_advancedEventSelectors
- Specifies the settings for advanced event selectors. You can add
advanced event selectors, and conditions for your advanced event
selectors, up to a maximum of 500 values for all conditions and
selectors on a trail. You can use either AdvancedEventSelectors
or
EventSelectors
, but not both. If you apply AdvancedEventSelectors
to
a trail, any existing EventSelectors
are overwritten. For more
information about advanced event selectors, see
Logging data events for trails
in the CloudTrail User Guide.
PutEventSelectors
, putEventSelectors_eventSelectors
- Specifies the settings for your event selectors. You can configure up to
five event selectors for a trail. You can use either EventSelectors
or
AdvancedEventSelectors
in a PutEventSelectors
request, but not both.
If you apply EventSelectors
to a trail, any existing
AdvancedEventSelectors
are overwritten.
$sel:trailName:PutEventSelectors'
, putEventSelectors_trailName
- Specifies the name of the trail or trail ARN. If you specify a trail
name, the string must meet the following requirements:
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. - Not be in IP address format (for example, 192.168.5.4)
If you specify a trail ARN, it must be in the following format.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
data PutEventSelectorsResponse Source #
See: newPutEventSelectorsResponse
smart constructor.
Instances
newPutEventSelectorsResponse Source #
Create a value of PutEventSelectorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutEventSelectors
, putEventSelectorsResponse_advancedEventSelectors
- Specifies the advanced event selectors configured for your trail.
PutEventSelectors
, putEventSelectorsResponse_eventSelectors
- Specifies the event selectors configured for your trail.
PutEventSelectorsResponse
, putEventSelectorsResponse_trailARN
- Specifies the ARN of the trail that was updated with event selectors.
The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
$sel:httpStatus:PutEventSelectorsResponse'
, putEventSelectorsResponse_httpStatus
- The response's http status code.
PutInsightSelectors
data PutInsightSelectors Source #
See: newPutInsightSelectors
smart constructor.
Instances
newPutInsightSelectors Source #
Create a value of PutInsightSelectors
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trailName:PutInsightSelectors'
, putInsightSelectors_trailName
- The name of the CloudTrail trail for which you want to change or add
Insights selectors.
PutInsightSelectors
, putInsightSelectors_insightSelectors
- A JSON string that contains the insight types you want to log on a
trail. ApiCallRateInsight
and ApiErrorRateInsight
are valid insight
types.
data PutInsightSelectorsResponse Source #
See: newPutInsightSelectorsResponse
smart constructor.
Instances
newPutInsightSelectorsResponse Source #
Create a value of PutInsightSelectorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutInsightSelectors
, putInsightSelectorsResponse_insightSelectors
- A JSON string that contains the Insights event types that you want to
log on a trail. The valid Insights types in this release are
ApiErrorRateInsight
and ApiCallRateInsight
.
PutInsightSelectorsResponse
, putInsightSelectorsResponse_trailARN
- The Amazon Resource Name (ARN) of a trail for which you want to change
or add Insights selectors.
$sel:httpStatus:PutInsightSelectorsResponse'
, putInsightSelectorsResponse_httpStatus
- The response's http status code.
RegisterOrganizationDelegatedAdmin
data RegisterOrganizationDelegatedAdmin Source #
Specifies an organization member account ID as a CloudTrail delegated administrator.
See: newRegisterOrganizationDelegatedAdmin
smart constructor.
Instances
newRegisterOrganizationDelegatedAdmin Source #
Create a value of RegisterOrganizationDelegatedAdmin
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:memberAccountId:RegisterOrganizationDelegatedAdmin'
, registerOrganizationDelegatedAdmin_memberAccountId
- An organization member account ID that you want to designate as a
delegated administrator.
data RegisterOrganizationDelegatedAdminResponse Source #
Returns the following response if successful. Otherwise, returns an error.
See: newRegisterOrganizationDelegatedAdminResponse
smart constructor.
Instances
Generic RegisterOrganizationDelegatedAdminResponse Source # | |
Defined in Amazonka.CloudTrail.RegisterOrganizationDelegatedAdmin type Rep RegisterOrganizationDelegatedAdminResponse :: Type -> Type # | |
Read RegisterOrganizationDelegatedAdminResponse Source # | |
Show RegisterOrganizationDelegatedAdminResponse Source # | |
NFData RegisterOrganizationDelegatedAdminResponse Source # | |
Eq RegisterOrganizationDelegatedAdminResponse Source # | |
type Rep RegisterOrganizationDelegatedAdminResponse Source # | |
Defined in Amazonka.CloudTrail.RegisterOrganizationDelegatedAdmin type Rep RegisterOrganizationDelegatedAdminResponse = D1 ('MetaData "RegisterOrganizationDelegatedAdminResponse" "Amazonka.CloudTrail.RegisterOrganizationDelegatedAdmin" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "RegisterOrganizationDelegatedAdminResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newRegisterOrganizationDelegatedAdminResponse Source #
Create a value of RegisterOrganizationDelegatedAdminResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RegisterOrganizationDelegatedAdminResponse'
, registerOrganizationDelegatedAdminResponse_httpStatus
- The response's http status code.
RemoveTags
data RemoveTags Source #
Specifies the tags to remove from a trail or event data store.
See: newRemoveTags
smart constructor.
Instances
:: Text | |
-> RemoveTags |
Create a value of RemoveTags
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RemoveTags
, removeTags_resourceId
- Specifies the ARN of the trail or event data store from which tags
should be removed.
Example trail ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Example event data store ARN format:
arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
RemoveTags
, removeTags_tagsList
- Specifies a list of tags to be removed.
data RemoveTagsResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newRemoveTagsResponse
smart constructor.
Instances
newRemoveTagsResponse Source #
Create a value of RemoveTagsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RemoveTagsResponse'
, removeTagsResponse_httpStatus
- The response's http status code.
RestoreEventDataStore
data RestoreEventDataStore Source #
See: newRestoreEventDataStore
smart constructor.
Instances
newRestoreEventDataStore Source #
Create a value of RestoreEventDataStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventDataStore:RestoreEventDataStore'
, restoreEventDataStore_eventDataStore
- The ARN (or the ID suffix of the ARN) of the event data store that you
want to restore.
data RestoreEventDataStoreResponse Source #
See: newRestoreEventDataStoreResponse
smart constructor.
RestoreEventDataStoreResponse' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe Bool) (Maybe POSIX) Int |
Instances
newRestoreEventDataStoreResponse Source #
Create a value of RestoreEventDataStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_advancedEventSelectors
- The advanced event selectors that were used to select events.
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_createdTimestamp
- The timestamp of an event data store's creation.
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_eventDataStoreArn
- The event data store ARN.
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_kmsKeyId
- Specifies the KMS key ID that encrypts the events delivered by
CloudTrail. The value is a fully specified ARN to a KMS key in the
following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_multiRegionEnabled
- Indicates whether the event data store is collecting events from all
regions, or only from the region in which the event data store was
created.
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_name
- The name of the event data store.
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_organizationEnabled
- Indicates whether an event data store is collecting logged events for an
organization in Organizations.
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_retentionPeriod
- The retention period, in days.
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_status
- The status of the event data store.
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_terminationProtectionEnabled
- Indicates that termination protection is enabled and the event data
store cannot be automatically deleted.
RestoreEventDataStoreResponse
, restoreEventDataStoreResponse_updatedTimestamp
- The timestamp that shows when an event data store was updated, if
applicable. UpdatedTimestamp
is always either the same or newer than
the time shown in CreatedTimestamp
.
$sel:httpStatus:RestoreEventDataStoreResponse'
, restoreEventDataStoreResponse_httpStatus
- The response's http status code.
StartImport
data StartImport Source #
See: newStartImport
smart constructor.
Instances
newStartImport :: StartImport Source #
Create a value of StartImport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartImport
, startImport_destinations
- The ARN of the destination event data store. Use this parameter for a
new import.
StartImport
, startImport_endEventTime
- Use with StartEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period. When you specify a time range, CloudTrail checks the prefix
and log file names to verify the names contain a date between the
specified StartEventTime
and EndEventTime
before attempting to
import events.
StartImport
, startImport_importId
- The ID of the import. Use this parameter when you are retrying an
import.
StartImport
, startImport_importSource
- The source S3 bucket for the import. Use this parameter for a new
import.
StartImport
, startImport_startEventTime
- Use with EndEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period. When you specify a time range, CloudTrail checks the prefix
and log file names to verify the names contain a date between the
specified StartEventTime
and EndEventTime
before attempting to
import events.
data StartImportResponse Source #
See: newStartImportResponse
smart constructor.
StartImportResponse' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe ImportSource) (Maybe ImportStatus) (Maybe POSIX) (Maybe POSIX) Int |
Instances
newStartImportResponse Source #
Create a value of StartImportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartImportResponse
, startImportResponse_createdTimestamp
- The timestamp for the import's creation.
StartImport
, startImportResponse_destinations
- The ARN of the destination event data store.
StartImport
, startImportResponse_endEventTime
- Used with StartEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period.
StartImport
, startImportResponse_importId
- The ID of the import.
StartImport
, startImportResponse_importSource
- The source S3 bucket for the import.
StartImportResponse
, startImportResponse_importStatus
- Shows the status of the import after a StartImport
request. An import
finishes with a status of COMPLETED
if there were no failures, or
FAILED
if there were failures.
StartImport
, startImportResponse_startEventTime
- Used with EndEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period.
StartImportResponse
, startImportResponse_updatedTimestamp
- The timestamp of the import's last update, if applicable.
$sel:httpStatus:StartImportResponse'
, startImportResponse_httpStatus
- The response's http status code.
StartLogging
data StartLogging Source #
The request to CloudTrail to start logging Amazon Web Services API calls for an account.
See: newStartLogging
smart constructor.
Instances
Create a value of StartLogging
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartLogging
, startLogging_name
- Specifies the name or the CloudTrail ARN of the trail for which
CloudTrail logs Amazon Web Services API calls. The following is the
format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
data StartLoggingResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newStartLoggingResponse
smart constructor.
Instances
newStartLoggingResponse Source #
Create a value of StartLoggingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartLoggingResponse'
, startLoggingResponse_httpStatus
- The response's http status code.
StartQuery
data StartQuery Source #
See: newStartQuery
smart constructor.
Instances
Create a value of StartQuery
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deliveryS3Uri:StartQuery'
, startQuery_deliveryS3Uri
- The URI for the S3 bucket where CloudTrail delivers the query results.
$sel:queryStatement:StartQuery'
, startQuery_queryStatement
- The SQL code of your query.
data StartQueryResponse Source #
See: newStartQueryResponse
smart constructor.
Instances
newStartQueryResponse Source #
Create a value of StartQueryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartQueryResponse
, startQueryResponse_queryId
- The ID of the started query.
$sel:httpStatus:StartQueryResponse'
, startQueryResponse_httpStatus
- The response's http status code.
StopImport
data StopImport Source #
See: newStopImport
smart constructor.
Instances
:: Text | |
-> StopImport |
Create a value of StopImport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopImport
, stopImport_importId
- The ID of the import.
data StopImportResponse Source #
See: newStopImportResponse
smart constructor.
StopImportResponse' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe ImportSource) (Maybe ImportStatistics) (Maybe ImportStatus) (Maybe POSIX) (Maybe POSIX) Int |
Instances
newStopImportResponse Source #
Create a value of StopImportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopImportResponse
, stopImportResponse_createdTimestamp
- The timestamp of the import's creation.
StopImportResponse
, stopImportResponse_destinations
- The ARN of the destination event data store.
$sel:endEventTime:StopImportResponse'
, stopImportResponse_endEventTime
- Used with StartEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period.
StopImport
, stopImportResponse_importId
- The ID for the import.
$sel:importSource:StopImportResponse'
, stopImportResponse_importSource
- The source S3 bucket for the import.
$sel:importStatistics:StopImportResponse'
, stopImportResponse_importStatistics
- Returns information on the stopped import.
StopImportResponse
, stopImportResponse_importStatus
- The status of the import.
$sel:startEventTime:StopImportResponse'
, stopImportResponse_startEventTime
- Used with EndEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period.
StopImportResponse
, stopImportResponse_updatedTimestamp
- The timestamp of the import's last update.
$sel:httpStatus:StopImportResponse'
, stopImportResponse_httpStatus
- The response's http status code.
StopLogging
data StopLogging Source #
Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.
See: newStopLogging
smart constructor.
Instances
Create a value of StopLogging
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopLogging
, stopLogging_name
- Specifies the name or the CloudTrail ARN of the trail for which
CloudTrail will stop logging Amazon Web Services API calls. The
following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
data StopLoggingResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newStopLoggingResponse
smart constructor.
Instances
newStopLoggingResponse Source #
Create a value of StopLoggingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopLoggingResponse'
, stopLoggingResponse_httpStatus
- The response's http status code.
UpdateEventDataStore
data UpdateEventDataStore Source #
See: newUpdateEventDataStore
smart constructor.
UpdateEventDataStore' (Maybe [AdvancedEventSelector]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Bool) Text |
Instances
newUpdateEventDataStore Source #
Create a value of UpdateEventDataStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateEventDataStore
, updateEventDataStore_advancedEventSelectors
- The advanced event selectors used to select events for the event data
store. You can configure up to five advanced event selectors for each
event data store.
UpdateEventDataStore
, updateEventDataStore_kmsKeyId
- Specifies the KMS key ID to use to encrypt the events delivered by
CloudTrail. The value can be an alias name prefixed by alias/
, a
fully specified ARN to an alias, a fully specified ARN to a key, or a
globally unique identifier.
Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
Examples:
alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
UpdateEventDataStore
, updateEventDataStore_multiRegionEnabled
- Specifies whether an event data store collects events from all regions,
or only from the region in which it was created.
UpdateEventDataStore
, updateEventDataStore_name
- The event data store name.
UpdateEventDataStore
, updateEventDataStore_organizationEnabled
- Specifies whether an event data store collects events logged for an
organization in Organizations.
UpdateEventDataStore
, updateEventDataStore_retentionPeriod
- The retention period, in days.
UpdateEventDataStore
, updateEventDataStore_terminationProtectionEnabled
- Indicates that termination protection is enabled and the event data
store cannot be automatically deleted.
$sel:eventDataStore:UpdateEventDataStore'
, updateEventDataStore_eventDataStore
- The ARN (or the ID suffix of the ARN) of the event data store that you
want to update.
data UpdateEventDataStoreResponse Source #
See: newUpdateEventDataStoreResponse
smart constructor.
UpdateEventDataStoreResponse' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe Bool) (Maybe POSIX) Int |
Instances
newUpdateEventDataStoreResponse Source #
Create a value of UpdateEventDataStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateEventDataStore
, updateEventDataStoreResponse_advancedEventSelectors
- The advanced event selectors that are applied to the event data store.
UpdateEventDataStoreResponse
, updateEventDataStoreResponse_createdTimestamp
- The timestamp that shows when an event data store was first created.
UpdateEventDataStoreResponse
, updateEventDataStoreResponse_eventDataStoreArn
- The ARN of the event data store.
UpdateEventDataStore
, updateEventDataStoreResponse_kmsKeyId
- Specifies the KMS key ID that encrypts the events delivered by
CloudTrail. The value is a fully specified ARN to a KMS key in the
following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
UpdateEventDataStore
, updateEventDataStoreResponse_multiRegionEnabled
- Indicates whether the event data store includes events from all regions,
or only from the region in which it was created.
UpdateEventDataStore
, updateEventDataStoreResponse_name
- The name of the event data store.
UpdateEventDataStore
, updateEventDataStoreResponse_organizationEnabled
- Indicates whether an event data store is collecting logged events for an
organization in Organizations.
UpdateEventDataStore
, updateEventDataStoreResponse_retentionPeriod
- The retention period, in days.
UpdateEventDataStoreResponse
, updateEventDataStoreResponse_status
- The status of an event data store. Values can be ENABLED
and
PENDING_DELETION
.
UpdateEventDataStore
, updateEventDataStoreResponse_terminationProtectionEnabled
- Indicates whether termination protection is enabled for the event data
store.
UpdateEventDataStoreResponse
, updateEventDataStoreResponse_updatedTimestamp
- The timestamp that shows when the event data store was last updated.
UpdatedTimestamp
is always either the same or newer than the time
shown in CreatedTimestamp
.
$sel:httpStatus:UpdateEventDataStoreResponse'
, updateEventDataStoreResponse_httpStatus
- The response's http status code.
UpdateTrail
data UpdateTrail Source #
Specifies settings to update for the trail.
See: newUpdateTrail
smart constructor.
UpdateTrail' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Create a value of UpdateTrail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTrail
, updateTrail_cloudWatchLogsLogGroupArn
- Specifies a log group name using an Amazon Resource Name (ARN), a unique
identifier that represents the log group to which CloudTrail logs are
delivered. Not required unless you specify CloudWatchLogsRoleArn
.
UpdateTrail
, updateTrail_cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to write
to a user's log group.
$sel:enableLogFileValidation:UpdateTrail'
, updateTrail_enableLogFileValidation
- Specifies whether log file validation is enabled. The default is false.
When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
UpdateTrail
, updateTrail_includeGlobalServiceEvents
- Specifies whether the trail is publishing events from global services
such as IAM to the log files.
UpdateTrail
, updateTrail_isMultiRegionTrail
- Specifies whether the trail applies only to the current region or to all
regions. The default is false. If the trail exists only in the current
region and this value is set to true, shadow trails (replications of the
trail) will be created in the other regions. If the trail exists in all
regions and this value is set to false, the trail will remain in the
region where it was created, and its shadow trails in other regions will
be deleted. As a best practice, consider using trails that log events in
all regions.
UpdateTrail
, updateTrail_isOrganizationTrail
- Specifies whether the trail is applied to all accounts in an
organization in Organizations, or only for the current Amazon Web
Services account. The default is false, and cannot be true unless the
call is made on behalf of an Amazon Web Services account that is the
management account for an organization in Organizations. If the trail is
not an organization trail and this is set to true
, the trail will be
created in all Amazon Web Services accounts that belong to the
organization. If the trail is an organization trail and this is set to
false
, the trail will remain in the current Amazon Web Services
account but be deleted from all member accounts in the organization.
UpdateTrail
, updateTrail_kmsKeyId
- Specifies the KMS key ID to use to encrypt the logs delivered by
CloudTrail. The value can be an alias name prefixed by "alias/", a
fully specified ARN to an alias, a fully specified ARN to a key, or a
globally unique identifier.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
Examples:
- alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
- 12345678-1234-1234-1234-123456789012
UpdateTrail
, updateTrail_s3BucketName
- Specifies the name of the Amazon S3 bucket designated for publishing log
files. See
Amazon S3 Bucket Naming Requirements.
UpdateTrail
, updateTrail_s3KeyPrefix
- Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery. For more information,
see
Finding Your CloudTrail Log Files.
The maximum length is 200 characters.
UpdateTrail
, updateTrail_snsTopicName
- Specifies the name of the Amazon SNS topic defined for notification of
log file delivery. The maximum length is 256 characters.
UpdateTrail
, updateTrail_name
- Specifies the name of the trail or trail ARN. If Name
is a trail name,
the string must meet the following requirements:
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. - Not be in IP address format (for example, 192.168.5.4)
If Name
is a trail ARN, it must be in the following format.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
data UpdateTrailResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newUpdateTrailResponse
smart constructor.
UpdateTrailResponse' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateTrailResponse Source #
Create a value of UpdateTrailResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTrail
, updateTrailResponse_cloudWatchLogsLogGroupArn
- Specifies the Amazon Resource Name (ARN) of the log group to which
CloudTrail logs are delivered.
UpdateTrail
, updateTrailResponse_cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to write
to a user's log group.
UpdateTrail
, updateTrailResponse_includeGlobalServiceEvents
- Specifies whether the trail is publishing events from global services
such as IAM to the log files.
UpdateTrail
, updateTrailResponse_isMultiRegionTrail
- Specifies whether the trail exists in one region or in all regions.
UpdateTrail
, updateTrailResponse_isOrganizationTrail
- Specifies whether the trail is an organization trail.
UpdateTrail
, updateTrailResponse_kmsKeyId
- Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
UpdateTrailResponse
, updateTrailResponse_logFileValidationEnabled
- Specifies whether log file integrity validation is enabled.
UpdateTrail
, updateTrailResponse_name
- Specifies the name of the trail.
UpdateTrail
, updateTrailResponse_s3BucketName
- Specifies the name of the Amazon S3 bucket designated for publishing log
files.
UpdateTrail
, updateTrailResponse_s3KeyPrefix
- Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery. For more information,
see
Finding Your IAM Log Files.
UpdateTrailResponse
, updateTrailResponse_snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
notifications when log files are delivered. The following is the format
of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
UpdateTrail
, updateTrailResponse_snsTopicName
- This field is no longer in use. Use UpdateTrailResponse$SnsTopicARN.
UpdateTrailResponse
, updateTrailResponse_trailARN
- Specifies the ARN of the trail that was updated. The following is the
format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
$sel:httpStatus:UpdateTrailResponse'
, updateTrailResponse_httpStatus
- The response's http status code.
Types
DeliveryStatus
newtype DeliveryStatus Source #
pattern DeliveryStatus_ACCESS_DENIED :: DeliveryStatus | |
pattern DeliveryStatus_ACCESS_DENIED_SIGNING_FILE :: DeliveryStatus | |
pattern DeliveryStatus_CANCELLED :: DeliveryStatus | |
pattern DeliveryStatus_FAILED :: DeliveryStatus | |
pattern DeliveryStatus_FAILED_SIGNING_FILE :: DeliveryStatus | |
pattern DeliveryStatus_PENDING :: DeliveryStatus | |
pattern DeliveryStatus_RESOURCE_NOT_FOUND :: DeliveryStatus | |
pattern DeliveryStatus_SUCCESS :: DeliveryStatus | |
pattern DeliveryStatus_UNKNOWN :: DeliveryStatus |
Instances
DestinationType
newtype DestinationType Source #
pattern DestinationType_AWS_SERVICE :: DestinationType | |
pattern DestinationType_EVENT_DATA_STORE :: DestinationType |
Instances
EventCategory
newtype EventCategory Source #
pattern EventCategory_Insight :: EventCategory |
Instances
EventDataStoreStatus
newtype EventDataStoreStatus Source #
pattern EventDataStoreStatus_CREATED :: EventDataStoreStatus | |
pattern EventDataStoreStatus_ENABLED :: EventDataStoreStatus | |
pattern EventDataStoreStatus_PENDING_DELETION :: EventDataStoreStatus |
Instances
ImportFailureStatus
newtype ImportFailureStatus Source #
pattern ImportFailureStatus_FAILED :: ImportFailureStatus | |
pattern ImportFailureStatus_RETRY :: ImportFailureStatus | |
pattern ImportFailureStatus_SUCCEEDED :: ImportFailureStatus |
Instances
ImportStatus
newtype ImportStatus Source #
pattern ImportStatus_COMPLETED :: ImportStatus | |
pattern ImportStatus_FAILED :: ImportStatus | |
pattern ImportStatus_INITIALIZING :: ImportStatus | |
pattern ImportStatus_IN_PROGRESS :: ImportStatus | |
pattern ImportStatus_STOPPED :: ImportStatus |
Instances
InsightType
newtype InsightType Source #
pattern InsightType_ApiCallRateInsight :: InsightType | |
pattern InsightType_ApiErrorRateInsight :: InsightType |
Instances
LookupAttributeKey
newtype LookupAttributeKey Source #
pattern LookupAttributeKey_AccessKeyId :: LookupAttributeKey | |
pattern LookupAttributeKey_EventId :: LookupAttributeKey | |
pattern LookupAttributeKey_EventName :: LookupAttributeKey | |
pattern LookupAttributeKey_EventSource :: LookupAttributeKey | |
pattern LookupAttributeKey_ReadOnly :: LookupAttributeKey | |
pattern LookupAttributeKey_ResourceName :: LookupAttributeKey | |
pattern LookupAttributeKey_ResourceType :: LookupAttributeKey | |
pattern LookupAttributeKey_Username :: LookupAttributeKey |
Instances
QueryStatus
newtype QueryStatus Source #
pattern QueryStatus_CANCELLED :: QueryStatus | |
pattern QueryStatus_FAILED :: QueryStatus | |
pattern QueryStatus_FINISHED :: QueryStatus | |
pattern QueryStatus_QUEUED :: QueryStatus | |
pattern QueryStatus_RUNNING :: QueryStatus | |
pattern QueryStatus_TIMED_OUT :: QueryStatus |
Instances
ReadWriteType
newtype ReadWriteType Source #
pattern ReadWriteType_All :: ReadWriteType | |
pattern ReadWriteType_ReadOnly :: ReadWriteType | |
pattern ReadWriteType_WriteOnly :: ReadWriteType |
Instances
AdvancedEventSelector
data AdvancedEventSelector Source #
Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.
readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN
You cannot apply both event selectors and advanced event selectors to a trail.
See: newAdvancedEventSelector
smart constructor.
Instances
newAdvancedEventSelector Source #
Create a value of AdvancedEventSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AdvancedEventSelector'
, advancedEventSelector_name
- An optional, descriptive name for an advanced event selector, such as
"Log data events for only two S3 buckets".
$sel:fieldSelectors:AdvancedEventSelector'
, advancedEventSelector_fieldSelectors
- Contains all selector statements in an advanced event selector.
AdvancedFieldSelector
data AdvancedFieldSelector Source #
A single selector statement in an advanced event selector.
See: newAdvancedFieldSelector
smart constructor.
AdvancedFieldSelector' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text |
Instances
newAdvancedFieldSelector Source #
Create a value of AdvancedFieldSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endsWith:AdvancedFieldSelector'
, advancedFieldSelector_endsWith
- An operator that includes events that match the last few characters of
the event record field specified as the value of Field
.
$sel:equals:AdvancedFieldSelector'
, advancedFieldSelector_equals
- An operator that includes events that match the exact value of the event
record field specified as the value of Field
. This is the only valid
operator that you can use with the readOnly
, eventCategory
, and
resources.type
fields.
$sel:notEndsWith:AdvancedFieldSelector'
, advancedFieldSelector_notEndsWith
- An operator that excludes events that match the last few characters of
the event record field specified as the value of Field
.
$sel:notEquals:AdvancedFieldSelector'
, advancedFieldSelector_notEquals
- An operator that excludes events that match the exact value of the event
record field specified as the value of Field
.
$sel:notStartsWith:AdvancedFieldSelector'
, advancedFieldSelector_notStartsWith
- An operator that excludes events that match the first few characters of
the event record field specified as the value of Field
.
$sel:startsWith:AdvancedFieldSelector'
, advancedFieldSelector_startsWith
- An operator that includes events that match the first few characters of
the event record field specified as the value of Field
.
$sel:field:AdvancedFieldSelector'
, advancedFieldSelector_field
- A field in an event record on which to filter events to be logged.
Supported fields include readOnly
, eventCategory
, eventSource
(for
management events), eventName
, resources.type
, and resources.ARN
.
readOnly
- Optional. Can be set toEquals
a value oftrue
orfalse
. If you do not add this field, CloudTrail logs bothread
andwrite
events. A value oftrue
logs onlyread
events. A value offalse
logs onlywrite
events.eventSource
- For filtering management events only. This can be set only toNotEquals
kms.amazonaws.com
.eventName
- Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such asPutBucket
orGetSnapshotBlock
. You can have multiple values for this field, separated by commas.eventCategory
- This is required. It must be set toEquals
, and the value must beManagement
orData
.resources.type
- This field is required.resources.type
can only use theEquals
operator, and the value can be one of the following:AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
You can have only one
resources.type
field per selector. To log data events on more than one resource type, add another selector.resources.ARN
- You can use any operator withresources.ARN
, but if you useEquals
orNotEquals
, the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equalsAWS::S3::Object
, the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use theStartsWith
operator, and include only the bucket ARN as the matching value.The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When
resources.type
equalsAWS::S3::AccessPoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use theStartsWith
orNotStartsWith
operators.arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals
AWS::Lambda::Function
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals
AWS::DynamoDB::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When
resources.type
equalsAWS::S3Outposts::Object
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When
resources.type
equalsAWS::ManagedBlockchain::Node
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When
resources.type
equalsAWS::S3ObjectLambda::AccessPoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When
resources.type
equalsAWS::EC2::Snapshot
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When
resources.type
equalsAWS::DynamoDB::Stream
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When
resources.type
equalsAWS::Glue::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
Channel
Contains information about a returned CloudTrail channel.
See: newChannel
smart constructor.
Instances
FromJSON Channel Source # | |
Generic Channel Source # | |
Read Channel Source # | |
Show Channel Source # | |
NFData Channel Source # | |
Defined in Amazonka.CloudTrail.Types.Channel | |
Eq Channel Source # | |
Hashable Channel Source # | |
Defined in Amazonka.CloudTrail.Types.Channel | |
type Rep Channel Source # | |
Defined in Amazonka.CloudTrail.Types.Channel type Rep Channel = D1 ('MetaData "Channel" "Amazonka.CloudTrail.Types.Channel" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "Channel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newChannel :: Channel Source #
Create a value of Channel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:Channel'
, channel_channelArn
- The Amazon Resource Name (ARN) of a channel.
$sel:name:Channel'
, channel_name
- The name of the CloudTrail channel. For service-linked channels, the
name is aws-service-channel/service-name/custom-suffix
where
service-name
represents the name of the Amazon Web Services service
that created the channel and custom-suffix
represents the suffix
created by the Amazon Web Services service.
DataResource
data DataResource Source #
The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.
The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.
If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.
The following example demonstrates how logging works when you configure
logging of all data events for an S3 bucket named bucket-1
. In this
example, the CloudTrail user specified an empty prefix, and the option
to log both Read
and Write
data events.
- A user uploads an image file to
bucket-1
. - The
PutObject
API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event. - A user uploads an object to an Amazon S3 bucket named
arn:aws:s3:::bucket-2
. - The
PutObject
API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.
The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction, but not for all Lambda functions.
- A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
- The
Invoke
API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event. - The
Invoke
API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, theInvoke
operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.
See: newDataResource
smart constructor.
DataResource' (Maybe Text) (Maybe [Text]) |
Instances
newDataResource :: DataResource Source #
Create a value of DataResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':DataResource'
, dataResource_type
- The resource type in which you want to log data events. You can specify
the following basic event selector resource types:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
The following resource types are also available through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector$Field.
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
$sel:values:DataResource'
, dataResource_values
- An array of Amazon Resource Name (ARN) strings or partial ARN strings
for the specified objects.
To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as
arn:aws:s3
.This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.
- To log data events for all objects in an S3 bucket, specify the
bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/
. The trail logs data events for all objects in this S3 bucket. - To log data events for specific objects, specify the S3 bucket and
object prefix such as
arn:aws:s3:::bucket-1/example-images
. The trail logs data events for objects in this S3 bucket that match the prefix. To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as
arn:aws:lambda
.This also enables logging of
Invoke
activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.To log data events for a specific Lambda function, specify the function ARN.
Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
- To log data events for all DynamoDB tables in your Amazon Web
Services account, specify the prefix as
arn:aws:dynamodb
.
Destination
data Destination Source #
Contains information about the service where CloudTrail delivers events.
See: newDestination
smart constructor.
Instances
Create a value of Destination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':Destination'
, destination_type
- The type of destination for events arriving from a channel. For
service-linked channels, the value is AWS_SERVICE
.
$sel:location:Destination'
, destination_location
- For service-linked channels, the value is the name of the Amazon Web
Services service.
Event
Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.
See: newEvent
smart constructor.
Event' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Resource]) (Maybe Text) |
Instances
Create a value of Event
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessKeyId:Event'
, event_accessKeyId
- The Amazon Web Services access key ID that was used to sign the request.
If the request was made with temporary security credentials, this is the
access key ID of the temporary credentials.
$sel:cloudTrailEvent:Event'
, event_cloudTrailEvent
- A JSON string that contains a representation of the event returned.
$sel:eventId:Event'
, event_eventId
- The CloudTrail ID of the event returned.
$sel:eventName:Event'
, event_eventName
- The name of the event returned.
$sel:eventSource:Event'
, event_eventSource
- The Amazon Web Services service to which the request was made.
$sel:eventTime:Event'
, event_eventTime
- The date and time of the event returned.
$sel:readOnly:Event'
, event_readOnly
- Information about whether the event is a write event or a read event.
$sel:resources:Event'
, event_resources
- A list of resources referenced by the event returned.
$sel:username:Event'
, event_username
- A user name or role name of the requester that called the API in the
event returned.
EventDataStore
data EventDataStore Source #
A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 90 to 2557 days (about three months to up to seven years). To select events for an event data store, use advanced event selectors.
See: newEventDataStore
smart constructor.
EventDataStore' (Maybe [AdvancedEventSelector]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe EventDataStoreStatus) (Maybe Bool) (Maybe POSIX) |
Instances
newEventDataStore :: EventDataStore Source #
Create a value of EventDataStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:advancedEventSelectors:EventDataStore'
, eventDataStore_advancedEventSelectors
- This field is being deprecated. The advanced event selectors that were
used to select events for the data store.
$sel:createdTimestamp:EventDataStore'
, eventDataStore_createdTimestamp
- This field is being deprecated. The timestamp of the event data store's
creation.
$sel:eventDataStoreArn:EventDataStore'
, eventDataStore_eventDataStoreArn
- The ARN of the event data store.
$sel:multiRegionEnabled:EventDataStore'
, eventDataStore_multiRegionEnabled
- This field is being deprecated. Indicates whether the event data store
includes events from all regions, or only from the region in which it
was created.
EventDataStore
, eventDataStore_name
- The name of the event data store.
$sel:organizationEnabled:EventDataStore'
, eventDataStore_organizationEnabled
- This field is being deprecated. Indicates that an event data store is
collecting logged events for an organization.
$sel:retentionPeriod:EventDataStore'
, eventDataStore_retentionPeriod
- This field is being deprecated. The retention period, in days.
$sel:status:EventDataStore'
, eventDataStore_status
- This field is being deprecated. The status of an event data store.
Values are ENABLED
and PENDING_DELETION
.
$sel:terminationProtectionEnabled:EventDataStore'
, eventDataStore_terminationProtectionEnabled
- This field is being deprecated. Indicates whether the event data store
is protected from termination.
$sel:updatedTimestamp:EventDataStore'
, eventDataStore_updatedTimestamp
- This field is being deprecated. The timestamp showing when an event data
store was updated, if applicable. UpdatedTimestamp
is always either
the same or newer than the time shown in CreatedTimestamp
.
EventSelector
data EventSelector Source #
Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
You can configure up to five event selectors for a trail.
You cannot apply both event selectors and advanced event selectors to a trail.
See: newEventSelector
smart constructor.
EventSelector' (Maybe [DataResource]) (Maybe [Text]) (Maybe Bool) (Maybe ReadWriteType) |
Instances
newEventSelector :: EventSelector Source #
Create a value of EventSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataResources:EventSelector'
, eventSelector_dataResources
- CloudTrail supports data event logging for Amazon S3 objects, Lambda
functions, and Amazon DynamoDB tables with basic event selectors. You
can specify up to 250 resources for an individual event selector, but
the total number of data resources cannot exceed 250 across all event
selectors in a trail. This limit does not apply if you configure
resource logging for all data events.
For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide.
$sel:excludeManagementEventSources:EventSelector'
, eventSelector_excludeManagementEventSources
- An optional list of service event sources from which you do not want
management events to be logged on your trail. In this release, the list
can be empty (disables the filter), or it can filter out Key Management
Service or Amazon RDS Data API events by containing kms.amazonaws.com
or rdsdata.amazonaws.com
. By default, ExcludeManagementEventSources
is empty, and KMS and Amazon RDS Data API events are logged to your
trail. You can exclude management event sources only in regions that
support the event source.
$sel:includeManagementEvents:EventSelector'
, eventSelector_includeManagementEvents
- Specify if you want your event selector to include management events for
your trail.
For more information, see Management Events in the CloudTrail User Guide.
By default, the value is true
.
The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see CloudTrail Pricing.
$sel:readWriteType:EventSelector'
, eventSelector_readWriteType
- Specify if you want your trail to log read-only events, write-only
events, or all. For example, the EC2 GetConsoleOutput
is a read-only
API operation and RunInstances
is a write-only API operation.
By default, the value is All
.
ImportFailureListItem
data ImportFailureListItem Source #
Provides information about an import failure.
See: newImportFailureListItem
smart constructor.
ImportFailureListItem' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ImportFailureStatus) |
Instances
newImportFailureListItem :: ImportFailureListItem Source #
Create a value of ImportFailureListItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorMessage:ImportFailureListItem'
, importFailureListItem_errorMessage
- Provides the reason the import failed.
$sel:errorType:ImportFailureListItem'
, importFailureListItem_errorType
- The type of import error.
$sel:lastUpdatedTime:ImportFailureListItem'
, importFailureListItem_lastUpdatedTime
- When the import was last updated.
$sel:location:ImportFailureListItem'
, importFailureListItem_location
- The location of the failure in the S3 bucket.
$sel:status:ImportFailureListItem'
, importFailureListItem_status
- The status of the import.
ImportSource
data ImportSource Source #
The import source.
See: newImportSource
smart constructor.
Instances
Create a value of ImportSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3:ImportSource'
, importSource_s3
- The source S3 bucket.
ImportStatistics
data ImportStatistics Source #
Provides statistics for the specified ImportID
. CloudTrail does not
update import statistics in real-time. Returned values for parameters
such as EventsCompleted
may be lower than the actual value, because
CloudTrail updates statistics incrementally over the course of the
import.
See: newImportStatistics
smart constructor.
Instances
newImportStatistics :: ImportStatistics Source #
Create a value of ImportStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventsCompleted:ImportStatistics'
, importStatistics_eventsCompleted
- The number of trail events imported into the event data store.
$sel:failedEntries:ImportStatistics'
, importStatistics_failedEntries
- The number of failed entries.
$sel:filesCompleted:ImportStatistics'
, importStatistics_filesCompleted
- The number of log files that completed import.
$sel:prefixesCompleted:ImportStatistics'
, importStatistics_prefixesCompleted
- The number of S3 prefixes that completed import.
$sel:prefixesFound:ImportStatistics'
, importStatistics_prefixesFound
- The number of S3 prefixes found for the import.
ImportsListItem
data ImportsListItem Source #
Contains information about an import that was returned by a lookup request.
See: newImportsListItem
smart constructor.
ImportsListItem' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe ImportStatus) (Maybe POSIX) |
Instances
newImportsListItem :: ImportsListItem Source #
Create a value of ImportsListItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdTimestamp:ImportsListItem'
, importsListItem_createdTimestamp
- The timestamp of the import's creation.
$sel:destinations:ImportsListItem'
, importsListItem_destinations
- The ARN of the destination event data store.
$sel:importId:ImportsListItem'
, importsListItem_importId
- The ID of the import.
$sel:importStatus:ImportsListItem'
, importsListItem_importStatus
- The status of the import.
$sel:updatedTimestamp:ImportsListItem'
, importsListItem_updatedTimestamp
- The timestamp of the import's last update.
InsightSelector
data InsightSelector Source #
A JSON string that contains a list of insight types that are logged on a trail.
See: newInsightSelector
smart constructor.
Instances
newInsightSelector :: InsightSelector Source #
Create a value of InsightSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:insightType:InsightSelector'
, insightSelector_insightType
- The type of insights to log on a trail. ApiCallRateInsight
and
ApiErrorRateInsight
are valid insight types.
LookupAttribute
data LookupAttribute Source #
Specifies an attribute and value that filter the events returned.
See: newLookupAttribute
smart constructor.
Instances
Create a value of LookupAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeKey:LookupAttribute'
, lookupAttribute_attributeKey
- Specifies an attribute on which to filter the events returned.
$sel:attributeValue:LookupAttribute'
, lookupAttribute_attributeValue
- Specifies a value for the specified AttributeKey.
PublicKey
Contains information about a returned public key.
See: newPublicKey
smart constructor.
Instances
newPublicKey :: PublicKey Source #
Create a value of PublicKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fingerprint:PublicKey'
, publicKey_fingerprint
- The fingerprint of the public key.
$sel:validityEndTime:PublicKey'
, publicKey_validityEndTime
- The ending time of validity of the public key.
$sel:validityStartTime:PublicKey'
, publicKey_validityStartTime
- The starting time of validity of the public key.
$sel:value:PublicKey'
, publicKey_value
- The DER encoded public key value in PKCS#1 format.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
Query
A SQL string of criteria about events that you want to collect in an event data store.
See: newQuery
smart constructor.
Instances
FromJSON Query Source # | |
Generic Query Source # | |
Read Query Source # | |
Show Query Source # | |
NFData Query Source # | |
Defined in Amazonka.CloudTrail.Types.Query | |
Eq Query Source # | |
Hashable Query Source # | |
Defined in Amazonka.CloudTrail.Types.Query | |
type Rep Query Source # | |
Defined in Amazonka.CloudTrail.Types.Query type Rep Query = D1 ('MetaData "Query" "Amazonka.CloudTrail.Types.Query" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "Query'" 'PrefixI 'True) (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryStatus))))) |
Create a value of Query
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:Query'
, query_creationTime
- The creation time of a query.
$sel:queryId:Query'
, query_queryId
- The ID of a query.
$sel:queryStatus:Query'
, query_queryStatus
- The status of the query. This can be QUEUED
, RUNNING
, FINISHED
,
FAILED
, TIMED_OUT
, or CANCELLED
.
QueryStatistics
data QueryStatistics Source #
Metadata about a query, such as the number of results.
See: newQueryStatistics
smart constructor.
Instances
newQueryStatistics :: QueryStatistics Source #
Create a value of QueryStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bytesScanned:QueryStatistics'
, queryStatistics_bytesScanned
- The total bytes that the query scanned in the event data store. This
value matches the number of bytes for which your account is billed for
the query, unless the query is still running.
$sel:resultsCount:QueryStatistics'
, queryStatistics_resultsCount
- The number of results returned.
$sel:totalResultsCount:QueryStatistics'
, queryStatistics_totalResultsCount
- The total number of results returned by a query.
QueryStatisticsForDescribeQuery
data QueryStatisticsForDescribeQuery Source #
Gets metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.
See: newQueryStatisticsForDescribeQuery
smart constructor.
QueryStatisticsForDescribeQuery' (Maybe Integer) (Maybe POSIX) (Maybe Integer) (Maybe Integer) (Maybe Int) |
Instances
newQueryStatisticsForDescribeQuery :: QueryStatisticsForDescribeQuery Source #
Create a value of QueryStatisticsForDescribeQuery
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bytesScanned:QueryStatisticsForDescribeQuery'
, queryStatisticsForDescribeQuery_bytesScanned
- The total bytes that the query scanned in the event data store. This
value matches the number of bytes for which your account is billed for
the query, unless the query is still running.
$sel:creationTime:QueryStatisticsForDescribeQuery'
, queryStatisticsForDescribeQuery_creationTime
- The creation time of the query.
$sel:eventsMatched:QueryStatisticsForDescribeQuery'
, queryStatisticsForDescribeQuery_eventsMatched
- The number of events that matched a query.
$sel:eventsScanned:QueryStatisticsForDescribeQuery'
, queryStatisticsForDescribeQuery_eventsScanned
- The number of events that the query scanned in the event data store.
$sel:executionTimeInMillis:QueryStatisticsForDescribeQuery'
, queryStatisticsForDescribeQuery_executionTimeInMillis
- The query's run time, in milliseconds.
Resource
Specifies the type and name of a resource referenced by an event.
See: newResource
smart constructor.
Instances
FromJSON Resource Source # | |
Generic Resource Source # | |
Read Resource Source # | |
Show Resource Source # | |
NFData Resource Source # | |
Defined in Amazonka.CloudTrail.Types.Resource | |
Eq Resource Source # | |
Hashable Resource Source # | |
Defined in Amazonka.CloudTrail.Types.Resource | |
type Rep Resource Source # | |
Defined in Amazonka.CloudTrail.Types.Resource type Rep Resource = D1 ('MetaData "Resource" "Amazonka.CloudTrail.Types.Resource" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "Resource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newResource :: Resource Source #
Create a value of Resource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceName:Resource'
, resource_resourceName
- The name of the resource referenced by the event returned. These are
user-created names whose values will depend on the environment. For
example, the resource name might be "auto-scaling-test-group" for an
Auto Scaling Group or "i-1234567" for an EC2 Instance.
$sel:resourceType:Resource'
, resource_resourceType
- The type of a resource referenced by the event returned. When the
resource type cannot be determined, null is returned. Some examples of
resource types are: Instance for EC2, Trail for CloudTrail,
DBInstance for Amazon RDS, and AccessKey for IAM. To learn more
about how to look up and filter events by the resource types supported
for a service, see
Filtering CloudTrail Events.
ResourceTag
data ResourceTag Source #
A resource tag.
See: newResourceTag
smart constructor.
ResourceTag' (Maybe Text) (Maybe [Tag]) |
Instances
newResourceTag :: ResourceTag Source #
Create a value of ResourceTag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceId:ResourceTag'
, resourceTag_resourceId
- Specifies the ARN of the resource.
$sel:tagsList:ResourceTag'
, resourceTag_tagsList
- A list of tags.
S3ImportSource
data S3ImportSource Source #
The settings for the source S3 bucket.
See: newS3ImportSource
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> S3ImportSource |
Create a value of S3ImportSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3LocationUri:S3ImportSource'
, s3ImportSource_s3LocationUri
- The URI for the source S3 bucket.
$sel:s3BucketRegion:S3ImportSource'
, s3ImportSource_s3BucketRegion
- The region associated with the source S3 bucket.
$sel:s3BucketAccessRoleArn:S3ImportSource'
, s3ImportSource_s3BucketAccessRoleArn
- The IAM ARN role used to access the source S3 bucket.
SourceConfig
data SourceConfig Source #
Contains configuration information about the channel.
See: newSourceConfig
smart constructor.
Instances
newSourceConfig :: SourceConfig Source #
Create a value of SourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:advancedEventSelectors:SourceConfig'
, sourceConfig_advancedEventSelectors
- The advanced event selectors that are configured for the channel.
$sel:applyToAllRegions:SourceConfig'
, sourceConfig_applyToAllRegions
- Specifies whether the channel applies to a single region or to all
regions.
Tag
A custom key-value pair associated with a resource such as a CloudTrail trail.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.CloudTrail.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.CloudTrail.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.CloudTrail.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.CloudTrail.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CloudTrail.Types.Tag" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Tag'
, tag_value
- The value in a key-value pair of a tag. The value must be no longer than
256 Unicode characters.
$sel:key:Tag'
, tag_key
- The key in a key-value pair. The key must be must be no longer than 128
Unicode characters. The key must be unique for the resource to which it
applies.
Trail
The settings for a trail.
See: newTrail
smart constructor.
Trail' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
Create a value of Trail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogsLogGroupArn:Trail'
, trail_cloudWatchLogsLogGroupArn
- Specifies an Amazon Resource Name (ARN), a unique identifier that
represents the log group to which CloudTrail logs will be delivered.
$sel:cloudWatchLogsRoleArn:Trail'
, trail_cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to write
to a user's log group.
$sel:hasCustomEventSelectors:Trail'
, trail_hasCustomEventSelectors
- Specifies if the trail has custom event selectors.
$sel:hasInsightSelectors:Trail'
, trail_hasInsightSelectors
- Specifies whether a trail has insight types specified in an
InsightSelector
list.
$sel:homeRegion:Trail'
, trail_homeRegion
- The region in which the trail was created.
$sel:includeGlobalServiceEvents:Trail'
, trail_includeGlobalServiceEvents
- Set to True to include Amazon Web Services API calls from Amazon Web
Services global services such as IAM. Otherwise, False.
$sel:isMultiRegionTrail:Trail'
, trail_isMultiRegionTrail
- Specifies whether the trail exists only in one region or exists in all
regions.
$sel:isOrganizationTrail:Trail'
, trail_isOrganizationTrail
- Specifies whether the trail is an organization trail.
$sel:kmsKeyId:Trail'
, trail_kmsKeyId
- Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
$sel:logFileValidationEnabled:Trail'
, trail_logFileValidationEnabled
- Specifies whether log file validation is enabled.
$sel:name:Trail'
, trail_name
- Name of the trail set by calling CreateTrail. The maximum length is 128
characters.
$sel:s3BucketName:Trail'
, trail_s3BucketName
- Name of the Amazon S3 bucket into which CloudTrail delivers your trail
files. See
Amazon S3 Bucket Naming Requirements.
$sel:s3KeyPrefix:Trail'
, trail_s3KeyPrefix
- Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery. For more information,
see
Finding Your CloudTrail Log Files.
The maximum length is 200 characters.
$sel:snsTopicARN:Trail'
, trail_snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
notifications when log files are delivered. The following is the format
of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
$sel:snsTopicName:Trail'
, trail_snsTopicName
- This field is no longer in use. Use SnsTopicARN.
$sel:trailARN:Trail'
, trail_trailARN
- Specifies the ARN of the trail. The following is the format of a trail
ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
TrailInfo
Information about a CloudTrail trail, including the trail's name, home region, and Amazon Resource Name (ARN).
See: newTrailInfo
smart constructor.
Instances
FromJSON TrailInfo Source # | |
Generic TrailInfo Source # | |
Read TrailInfo Source # | |
Show TrailInfo Source # | |
NFData TrailInfo Source # | |
Defined in Amazonka.CloudTrail.Types.TrailInfo | |
Eq TrailInfo Source # | |
Hashable TrailInfo Source # | |
Defined in Amazonka.CloudTrail.Types.TrailInfo | |
type Rep TrailInfo Source # | |
Defined in Amazonka.CloudTrail.Types.TrailInfo type Rep TrailInfo = D1 ('MetaData "TrailInfo" "Amazonka.CloudTrail.Types.TrailInfo" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "TrailInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "homeRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "trailARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newTrailInfo :: TrailInfo Source #
Create a value of TrailInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:homeRegion:TrailInfo'
, trailInfo_homeRegion
- The Amazon Web Services Region in which a trail was created.
$sel:name:TrailInfo'
, trailInfo_name
- The name of a trail.
$sel:trailARN:TrailInfo'
, trailInfo_trailARN
- The ARN of a trail.