ExportSummary
A summary of an export job, as returned by ListExportJobsV2.
Contents
- DataType
-
The category of data that the export job produces.
Type: String
Valid Values:
FINDINGSRequired: Yes
- Destination
-
The destination that the export job writes to.
Type: ExportDestination object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- ExportJobId
-
The unique identifier of the export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-z0-9]+$Required: Yes
- StartedAt
-
The time when the export job was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
Type: Timestamp
Required: Yes
- Status
-
The current state of the export job.
Type: String
Valid Values:
RUNNING | SUCCEEDED | FAILED | CANCELLEDRequired: Yes
- EndedAt
-
The time when the export job reached a terminal state. Absent while the job is
RUNNING.For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
Type: Timestamp
Required: No
- FailureCode
-
A code that classifies why the export job failed. Present only when
StatusisFAILED.Type: String
Valid Values:
ACCESS_DENIED | RESOURCE_NOT_FOUND | INTERNAL_ERRORRequired: No
- FailureMessage
-
A human-readable message about why the export job failed. Present only when
StatusisFAILED.Type: String
Pattern:
.*\S.*Required: No
- Name
-
The user-provided name of the export job, if one was specified.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- OutputConfiguration
-
The output configuration of the export job. For findings exports, this reports the output format. Present only for findings exports; absent for other data types.
Type: ExportOutputSummary object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- Scopes
-
The organization scopes that the export job was started with, echoed verbatim. Absent if the caller didn't supply
Scopes.Type: ExportScopes object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: