Amazonka.CloudTrail.StartImport

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.

Creating a Request

data StartImport

See: newStartImport smart constructor.

Constructors

StartImport'

Fields

• destinations :: Maybe (NonEmpty Text)

  The ARN of the destination event data store. Use this parameter for a new import.

• endEventTime :: Maybe POSIX

  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.

• importId :: Maybe Text

  The ID of the import. Use this parameter when you are retrying an import.

• importSource :: Maybe ImportSource

  The source S3 bucket for the import. Use this parameter for a new import.

• startEventTime :: Maybe POSIX

  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.

Instances

ToJSON StartImport

Defined in Amazonka.CloudTrail.StartImport

Methods

toJSON :: StartImport -> Value

toEncoding :: StartImport -> Encoding

toJSONList :: [StartImport] -> Value

toEncodingList :: [StartImport] -> Encoding

ToHeaders StartImport

Defined in Amazonka.CloudTrail.StartImport

Methods

toHeaders :: StartImport -> [Header]

ToPath StartImport

Defined in Amazonka.CloudTrail.StartImport

Methods

toPath :: StartImport -> ByteString

ToQuery StartImport

Defined in Amazonka.CloudTrail.StartImport

Methods

toQuery :: StartImport -> QueryString

AWSRequest StartImport

Defined in Amazonka.CloudTrail.StartImport

Associated Types

type AWSResponse StartImport

Methods

request :: (Service -> Service) -> StartImport -> Request StartImport

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartImport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartImport)))

Generic StartImport

Defined in Amazonka.CloudTrail.StartImport

Associated Types

type Rep StartImport :: Type -> Type

Methods

from :: StartImport -> Rep StartImport x

to :: Rep StartImport x -> StartImport

Read StartImport

Defined in Amazonka.CloudTrail.StartImport

Methods

readsPrec :: Int -> ReadS StartImport

readList :: ReadS [StartImport]

readPrec :: ReadPrec StartImport

readListPrec :: ReadPrec [StartImport]

Show StartImport

Defined in Amazonka.CloudTrail.StartImport

Methods

showsPrec :: Int -> StartImport -> ShowS

show :: StartImport -> String

showList :: [StartImport] -> ShowS

NFData StartImport

Defined in Amazonka.CloudTrail.StartImport

Methods

rnf :: StartImport -> ()

Eq StartImport

Defined in Amazonka.CloudTrail.StartImport

Methods

(==) :: StartImport -> StartImport -> Bool

(/=) :: StartImport -> StartImport -> Bool

Hashable StartImport

Defined in Amazonka.CloudTrail.StartImport

Methods

hashWithSalt :: Int -> StartImport -> Int

hash :: StartImport -> Int

type AWSResponse StartImport

Defined in Amazonka.CloudTrail.StartImport

type AWSResponse StartImport = StartImportResponse

type Rep StartImport

Defined in Amazonka.CloudTrail.StartImport

type Rep StartImport = D1 ('MetaData "StartImport" "Amazonka.CloudTrail.StartImport" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "StartImport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "endEventTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "importId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "importSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportSource)) :*: S1 ('MetaSel ('Just "startEventTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newStartImport :: StartImport

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))

The ARN of the destination event data store. Use this parameter for a new import.

startImport_endEventTime :: Lens' StartImport (Maybe UTCTime)

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)

The ID of the import. Use this parameter when you are retrying an import.

startImport_importSource :: Lens' StartImport (Maybe ImportSource)

The source S3 bucket for the import. Use this parameter for a new import.

startImport_startEventTime :: Lens' StartImport (Maybe UTCTime)

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

See: newStartImportResponse smart constructor.

Constructors

StartImportResponse'

Fields

• createdTimestamp :: Maybe POSIX

  The timestamp for the import's creation.

• destinations :: Maybe (NonEmpty Text)

  The ARN of the destination event data store.

• endEventTime :: Maybe POSIX

  Used with StartEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

• importId :: Maybe Text

  The ID of the import.

• importSource :: Maybe ImportSource

  The source S3 bucket for the import.

• importStatus :: Maybe 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.

• startEventTime :: Maybe POSIX

  Used with EndEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

• updatedTimestamp :: Maybe POSIX

  The timestamp of the import's last update, if applicable.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartImportResponse

Defined in Amazonka.CloudTrail.StartImport

Associated Types

type Rep StartImportResponse :: Type -> Type

Methods

from :: StartImportResponse -> Rep StartImportResponse x

to :: Rep StartImportResponse x -> StartImportResponse

Read StartImportResponse

Defined in Amazonka.CloudTrail.StartImport

Methods

readsPrec :: Int -> ReadS StartImportResponse

readList :: ReadS [StartImportResponse]

readPrec :: ReadPrec StartImportResponse

readListPrec :: ReadPrec [StartImportResponse]

Show StartImportResponse

Defined in Amazonka.CloudTrail.StartImport

Methods

showsPrec :: Int -> StartImportResponse -> ShowS

show :: StartImportResponse -> String

showList :: [StartImportResponse] -> ShowS

NFData StartImportResponse

Defined in Amazonka.CloudTrail.StartImport

Methods

rnf :: StartImportResponse -> ()

Eq StartImportResponse

Defined in Amazonka.CloudTrail.StartImport

Methods

(==) :: StartImportResponse -> StartImportResponse -> Bool

(/=) :: StartImportResponse -> StartImportResponse -> Bool

type Rep StartImportResponse

Defined in Amazonka.CloudTrail.StartImport

type Rep StartImportResponse = D1 ('MetaData "StartImportResponse" "Amazonka.CloudTrail.StartImport" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "StartImportResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "endEventTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "importId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "importSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportSource)) :*: S1 ('MetaSel ('Just "importStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportStatus))) :*: (S1 ('MetaSel ('Just "startEventTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "updatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newStartImportResponse

Arguments

:: Int

$sel:httpStatus:StartImportResponse'

-> StartImportResponse

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)

The timestamp for the import's creation.

startImportResponse_destinations :: Lens' StartImportResponse (Maybe (NonEmpty Text))

The ARN of the destination event data store.

startImportResponse_endEventTime :: Lens' StartImportResponse (Maybe UTCTime)

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)

The ID of the import.

startImportResponse_importSource :: Lens' StartImportResponse (Maybe ImportSource)

The source S3 bucket for the import.

startImportResponse_importStatus :: Lens' StartImportResponse (Maybe 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.

startImportResponse_startEventTime :: Lens' StartImportResponse (Maybe UTCTime)

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)

The timestamp of the import's last update, if applicable.

startImportResponse_httpStatus :: Lens' StartImportResponse Int

The response's http status code.