Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:getBucketLocation, sns:SetRegion, sns:ListTopics, sns:Publish, iam:GetRolePolicy.
See: AWS API Reference for GenerateDataSet.
- generateDataSet :: DataSetType -> UTCTime -> Text -> Text -> Text -> GenerateDataSet
- data GenerateDataSet
- gdsDestinationS3Prefix :: Lens' GenerateDataSet (Maybe Text)
- gdsDataSetType :: Lens' GenerateDataSet DataSetType
- gdsDataSetPublicationDate :: Lens' GenerateDataSet UTCTime
- gdsRoleNameARN :: Lens' GenerateDataSet Text
- gdsDestinationS3BucketName :: Lens' GenerateDataSet Text
- gdsSnsTopicARN :: Lens' GenerateDataSet Text
- generateDataSetResponse :: Int -> GenerateDataSetResponse
- data GenerateDataSetResponse
- gdsrsDataSetRequestId :: Lens' GenerateDataSetResponse (Maybe Text)
- gdsrsResponseStatus :: Lens' GenerateDataSetResponse Int
Creating a Request
:: DataSetType | |
-> UTCTime | |
-> Text | |
-> Text | |
-> Text | |
-> GenerateDataSet |
Creates a value of GenerateDataSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GenerateDataSet Source
Container for the parameters to the GenerateDataSet operation.
See: generateDataSet
smart constructor.
Request Lenses
gdsDestinationS3Prefix :: Lens' GenerateDataSet (Maybe Text) Source
Undocumented member.
gdsDataSetType :: Lens' GenerateDataSet DataSetType Source
Undocumented member.
gdsDataSetPublicationDate :: Lens' GenerateDataSet UTCTime Source
Undocumented member.
gdsRoleNameARN :: Lens' GenerateDataSet Text Source
Undocumented member.
gdsDestinationS3BucketName :: Lens' GenerateDataSet Text Source
Undocumented member.
gdsSnsTopicARN :: Lens' GenerateDataSet Text Source
Undocumented member.
Destructuring the Response
generateDataSetResponse Source
Creates a value of GenerateDataSetResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GenerateDataSetResponse Source
Container for the result of the GenerateDataSet operation.
See: generateDataSetResponse
smart constructor.
Response Lenses
gdsrsDataSetRequestId :: Lens' GenerateDataSetResponse (Maybe Text) Source
Undocumented member.
gdsrsResponseStatus :: Lens' GenerateDataSetResponse Int Source
The response status code.