ForecastService / Client / list_what_if_forecast_exports

list_what_if_forecast_exports

ForecastService.Client.list_what_if_forecast_exports(**kwargs)

Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation.

See also: AWS API Documentation

Request Syntax

response = client.list_what_if_forecast_exports(
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Key': 'string',
            'Value': 'string',
            'Condition': 'IS'|'IS_NOT'
        },
    ]
)

Parameters:

• NextToken (string) – If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

• MaxResults (integer) – The number of items to return in the response.

• Filters (list) –

  An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the what-if forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

  Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecast export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are WhatIfForecastExportArn and Status.

  • Value - The value to match.

  For example, to list all jobs that export a forecast named electricityWIFExport, specify the following filter:

  "Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ]

  • (dict) –

    Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.

    • Key (string) – [REQUIRED]

      The name of the parameter to filter on.

    • Value (string) – [REQUIRED]

      The value to match.

    • Condition (string) – [REQUIRED]

      The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • WhatIfForecastExports (list) –

    An array of WhatIfForecastExports objects that describe the matched forecast exports.

    • (dict) –

      Provides a summary of the what-if forecast export properties used in the ListWhatIfForecastExports operation. To get the complete set of properties, call the DescribeWhatIfForecastExport operation, and provide the WhatIfForecastExportArn that is listed in the summary.

      • WhatIfForecastExportArn (string) –

        The Amazon Resource Name (ARN) of the what-if forecast export.

      • WhatIfForecastArns (list) –

        An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

        • (string) –

      • WhatIfForecastExportName (string) –

        The what-if forecast export name.

      • 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.

      • Status (string) –

        The status of the what-if forecast export. 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 analysis must be ACTIVE before you can access the analysis.

      • Message (string) –

        If an error occurred, an informational message about the error.

      • CreationTime (datetime) –

        When the what-if forecast export was created.

      • 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.

  • NextToken (string) –

    If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.

Exceptions

• ForecastService.Client.exceptions.InvalidNextTokenException

• ForecastService.Client.exceptions.InvalidInputException