ForecastService.Paginator.
ListForecastExportJobs
¶paginator = client.get_paginator('list_forecast_export_jobs')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from ForecastService.Client.list_forecast_export_jobs()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Value': 'string',
'Condition': 'IS'|'IS_NOT'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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 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 ForecastArn
and Status
.Value
- The value to match.For example, to list all jobs that export a forecast named electricityforecast , specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
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.
The name of the parameter to filter on.
The value to match.
The condition to apply. To include the objects that match the statement, specify IS
. To exclude matching objects, specify IS_NOT
.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'ForecastExportJobs': [
{
'ForecastExportJobArn': 'string',
'ForecastExportJobName': 'string',
'Destination': {
'S3Config': {
'Path': 'string',
'RoleArn': 'string',
'KMSKeyArn': 'string'
}
},
'Status': 'string',
'Message': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastModificationTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
ForecastExportJobs (list) --
An array of objects that summarize each export job's properties.
(dict) --
Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed ForecastExportJobArn
.
ForecastExportJobArn (string) --
The Amazon Resource Name (ARN) of the forecast export job.
ForecastExportJobName (string) --
The name of the forecast export job.
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 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 be ACTIVE
before you can access the forecast in your S3 bucket.
Message (string) --
If an error occurred, an informational message about the error.
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
- 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.