ForecastService / Client / describe_forecast_export_job
describe_forecast_export_job#
- ForecastService.Client.describe_forecast_export_job(**kwargs)#
Describes a forecast export job created using the CreateForecastExportJob operation.
In addition to listing the properties provided by the user in the
CreateForecastExportJob
request, this operation lists the following properties:CreationTime
LastModificationTime
Status
Message
- If an error occurred, information about the error.
See also: AWS API Documentation
Request Syntax
response = client.describe_forecast_export_job( ForecastExportJobArn='string' )
- Parameters:
ForecastExportJobArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the forecast export job.
- Return type:
dict
- Returns:
Response Syntax
{ 'ForecastExportJobArn': 'string', 'ForecastExportJobName': 'string', 'ForecastArn': 'string', 'Destination': { 'S3Config': { 'Path': 'string', 'RoleArn': 'string', 'KMSKeyArn': 'string' } }, 'Message': 'string', 'Status': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModificationTime': datetime(2015, 1, 1), 'Format': 'string' }
Response Structure
(dict) –
ForecastExportJobArn (string) –
The ARN of the forecast export job.
ForecastExportJobName (string) –
The name of the forecast export job.
ForecastArn (string) –
The Amazon Resource Name (ARN) of the exported forecast.
Destination (dict) –
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
S3Config (dict) –
The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.
Path (string) –
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
RoleArn (string) –
The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the
KMSKeyArn
key, the role must allow access to the key.Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn’t in your account, you get an
InvalidInputException
error.KMSKeyArn (string) –
The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
Message (string) –
If an error occurred, an informational message about the error.
Status (string) –
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
Note
The
Status
of the forecast export job must beACTIVE
before you can access the forecast in your S3 bucket.CreationTime (datetime) –
When the forecast export job was created.
LastModificationTime (datetime) –
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
Format (string) –
The format of the exported data, CSV or PARQUET.
Exceptions