[ aws . forecast ]

describe-forecast-export-job

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-forecast-export-job
--forecast-export-job-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--forecast-export-job-arn (string)

The Amazon Resource Name (ARN) of the forecast export job.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

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

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

S3Config -> (structure)

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

• DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED

Note

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

CreationTime -> (timestamp)

When the forecast export job was created.

LastModificationTime -> (timestamp)

When the last successful export job finished.