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 |
Starts an import of logged trail events from a source S3 bucket to a
destination event data store. By default, CloudTrail only imports events
contained in the S3 bucket's CloudTrail
prefix and the prefixes
inside the CloudTrail
prefix, and does not check prefixes for other
Amazon Web Services services. If you want to import CloudTrail events
contained in another prefix, you must include the prefix in the
S3LocationUri
. For more considerations about importing trail events,
see
Considerations.
When you start a new import, the Destinations
and ImportSource
parameters are required. Before starting a new import, disable any
access control lists (ACLs) attached to the source S3 bucket. For more
information about disabling ACLs, see
Controlling ownership of objects and disabling ACLs for your bucket.
When you retry an import, the ImportID
parameter is required.
Synopsis
- data StartImport = StartImport' {}
- newStartImport :: StartImport
- startImport_destinations :: Lens' StartImport (Maybe (NonEmpty Text))
- startImport_endEventTime :: Lens' StartImport (Maybe UTCTime)
- startImport_importId :: Lens' StartImport (Maybe Text)
- startImport_importSource :: Lens' StartImport (Maybe ImportSource)
- startImport_startEventTime :: Lens' StartImport (Maybe UTCTime)
- data StartImportResponse = StartImportResponse' {}
- newStartImportResponse :: Int -> StartImportResponse
- startImportResponse_createdTimestamp :: Lens' StartImportResponse (Maybe UTCTime)
- startImportResponse_destinations :: Lens' StartImportResponse (Maybe (NonEmpty Text))
- startImportResponse_endEventTime :: Lens' StartImportResponse (Maybe UTCTime)
- startImportResponse_importId :: Lens' StartImportResponse (Maybe Text)
- startImportResponse_importSource :: Lens' StartImportResponse (Maybe ImportSource)
- startImportResponse_importStatus :: Lens' StartImportResponse (Maybe ImportStatus)
- startImportResponse_startEventTime :: Lens' StartImportResponse (Maybe UTCTime)
- startImportResponse_updatedTimestamp :: Lens' StartImportResponse (Maybe UTCTime)
- startImportResponse_httpStatus :: Lens' StartImportResponse Int
Creating a Request
data StartImport Source #
See: newStartImport
smart constructor.
StartImport' | |
|
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.
Request Lenses
startImport_destinations :: Lens' StartImport (Maybe (NonEmpty Text)) Source #
The ARN of the destination event data store. Use this parameter for a new import.
startImport_endEventTime :: Lens' StartImport (Maybe UTCTime) Source #
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_importId :: Lens' StartImport (Maybe Text) Source #
The ID of the import. Use this parameter when you are retrying an import.
startImport_importSource :: Lens' StartImport (Maybe ImportSource) Source #
The source S3 bucket for the import. Use this parameter for a new import.
startImport_startEventTime :: Lens' StartImport (Maybe UTCTime) Source #
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.
Destructuring the Response
data StartImportResponse Source #
See: newStartImportResponse
smart constructor.
StartImportResponse' | |
|
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.
Response Lenses
startImportResponse_createdTimestamp :: Lens' StartImportResponse (Maybe UTCTime) Source #
The timestamp for the import's creation.
startImportResponse_destinations :: Lens' StartImportResponse (Maybe (NonEmpty Text)) Source #
The ARN of the destination event data store.
startImportResponse_endEventTime :: Lens' StartImportResponse (Maybe UTCTime) Source #
Used with StartEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period.
startImportResponse_importId :: Lens' StartImportResponse (Maybe Text) Source #
The ID of the import.
startImportResponse_importSource :: Lens' StartImportResponse (Maybe ImportSource) Source #
The source S3 bucket for the import.
startImportResponse_importStatus :: Lens' StartImportResponse (Maybe ImportStatus) Source #
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.
startImportResponse_startEventTime :: Lens' StartImportResponse (Maybe UTCTime) Source #
Used with EndEventTime
to bound a StartImport
request, and limit
imported trail events to only those events logged within a specified
time period.
startImportResponse_updatedTimestamp :: Lens' StartImportResponse (Maybe UTCTime) Source #
The timestamp of the import's last update, if applicable.
startImportResponse_httpStatus :: Lens' StartImportResponse Int Source #
The response's http status code.