ForecastService / Client / describe_what_if_forecast_export

describe_what_if_forecast_export¶

ForecastService.Client.describe_what_if_forecast_export(**kwargs)¶

Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.

In addition to listing the properties provided in the CreateWhatIfForecastExport request, this operation lists the following properties:

CreationTime
LastModificationTime
Message - If an error occurred, information about the error.
Status

Request Syntax

response = client.describe_what_if_forecast_export(
    WhatIfForecastExportArn='string'
)

Parameters:

WhatIfForecastExportArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.

Return type:

dict

Returns:

Response Syntax

{
    'WhatIfForecastExportArn': 'string',
    'WhatIfForecastExportName': 'string',
    'WhatIfForecastArns': [
        'string',
    ],
    'Destination': {
        'S3Config': {
            'Path': 'string',
            'RoleArn': 'string',
            'KMSKeyArn': 'string'
        }
    },
    'Message': 'string',
    'Status': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'EstimatedTimeRemainingInMinutes': 123,
    'LastModificationTime': datetime(2015, 1, 1),
    'Format': 'string'
}

Response Structure

(dict) –
- WhatIfForecastExportArn (string) –
  
  The Amazon Resource Name (ARN) of the what-if forecast export.
- WhatIfForecastExportName (string) –
  
  The name of the what-if forecast export.
- WhatIfForecastArns (list) –
  
  An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
  - (string) –
- Destination (dict) –
  
  The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).
  - 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 what-if forecast. 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 what-if forecast export must be ACTIVE before you can access the forecast export.
- CreationTime (datetime) –
  
  When the what-if forecast export was created.
- EstimatedTimeRemainingInMinutes (integer) –
  
  The approximate time remaining to complete the what-if forecast export, in minutes.
- LastModificationTime (datetime) –
  
  The last time the resource was modified. The timestamp depends on the status of the job:
  - CREATE_PENDING - The CreationTime.
  - CREATE_IN_PROGRESS - The current timestamp.
  - CREATE_STOPPING - The current timestamp.
  - CREATE_STOPPED - When the job stopped.
  - ACTIVE or CREATE_FAILED - When the job finished or failed.
- Format (string) –
  
  The format of the exported data, CSV or PARQUET.

Exceptions

ForecastService.Client.exceptions.InvalidInputException
ForecastService.Client.exceptions.ResourceNotFoundException