ForecastService / Client / create_what_if_forecast_export

create_what_if_forecast_export#

ForecastService.Client.create_what_if_forecast_export(**kwargs)#

Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.

Note

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.

See also: AWS API Documentation

Request Syntax

response = client.create_what_if_forecast_export(
    WhatIfForecastExportName='string',
    WhatIfForecastArns=[
        'string',
    ],
    Destination={
        'S3Config': {
            'Path': 'string',
            'RoleArn': 'string',
            'KMSKeyArn': 'string'
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Format='string'
)
Parameters:

  • WhatIfForecastExportName (string) –

    [REQUIRED]

    The name of the what-if forecast to export.

  • WhatIfForecastArns (list) –

    [REQUIRED]

    The list of what-if forecast Amazon Resource Names (ARNs) to export.

    • (string) –

  • Destination (dict) –

    [REQUIRED]

    The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

    If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

    • S3Config (dict) – [REQUIRED]

      The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

      • Path (string) – [REQUIRED]

        The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

      • RoleArn (string) – [REQUIRED]

        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.

  • Tags (list) –

    A list of tags to apply to the what if forecast.

    • (dict) –

      The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      • Key (string) – [REQUIRED]

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value (string) – [REQUIRED]

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

  • Format (string) – The format of the exported data, CSV or PARQUET.

Return type:

dict

Returns:

Response Syntax

{
    'WhatIfForecastExportArn': 'string'
}

Response Structure

  • (dict) –

    • WhatIfForecastExportArn (string) –

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

Exceptions