Network.AWS.MarketplaceAnalytics.StartSupportDataExport

Given a data set type and a from date, asynchronously publishes the requested customer support data 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'T'HH-mm-ss'Z'.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:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.

Creating a Request

startSupportDataExport

Arguments

:: SupportDataSetType

ssdeDataSetType

-> UTCTime

ssdeFromDate

-> Text

ssdeRoleNameARN

-> Text

ssdeDestinationS3BucketName

-> Text

ssdeSnsTopicARN

-> StartSupportDataExport

Creates a value of StartSupportDataExport with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ssdeCustomerDefinedValues - (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.
• ssdeDestinationS3Prefix - (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefixmydatasets", the output file "outputfile" would be published to "s3:mybucketmyprefixmydatasetsoutputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.
• ssdeDataSetType - Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time. Currently, only the test_customer_support_contacts_data value is supported * customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter. * test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data
• ssdeFromDate - The start date from which to retrieve the data set. This parameter only affects the customer_support_contacts_data data set type.
• ssdeRoleNameARN - The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
• ssdeDestinationS3BucketName - The name (friendly name, not ARN) of the destination S3 bucket.
• ssdeSnsTopicARN - Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

data StartSupportDataExport

Container for the parameters to the StartSupportDataExport operation.

See: startSupportDataExport smart constructor.

Instances

Eq StartSupportDataExport

Methods

(==) :: StartSupportDataExport -> StartSupportDataExport -> Bool

(/=) :: StartSupportDataExport -> StartSupportDataExport -> Bool

Data StartSupportDataExport

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartSupportDataExport -> c StartSupportDataExport

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartSupportDataExport

toConstr :: StartSupportDataExport -> Constr

dataTypeOf :: StartSupportDataExport -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartSupportDataExport)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartSupportDataExport)

gmapT :: (forall b. Data b => b -> b) -> StartSupportDataExport -> StartSupportDataExport

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartSupportDataExport -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartSupportDataExport -> r

gmapQ :: (forall d. Data d => d -> u) -> StartSupportDataExport -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartSupportDataExport -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartSupportDataExport -> m StartSupportDataExport

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartSupportDataExport -> m StartSupportDataExport

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartSupportDataExport -> m StartSupportDataExport

Read StartSupportDataExport

Methods

readsPrec :: Int -> ReadS StartSupportDataExport

readList :: ReadS [StartSupportDataExport]

readPrec :: ReadPrec StartSupportDataExport

readListPrec :: ReadPrec [StartSupportDataExport]

Show StartSupportDataExport

Methods

showsPrec :: Int -> StartSupportDataExport -> ShowS

show :: StartSupportDataExport -> String

showList :: [StartSupportDataExport] -> ShowS

Generic StartSupportDataExport

Associated Types

type Rep StartSupportDataExport :: * -> *

Methods

from :: StartSupportDataExport -> Rep StartSupportDataExport x

to :: Rep StartSupportDataExport x -> StartSupportDataExport

Hashable StartSupportDataExport

Methods

hashWithSalt :: Int -> StartSupportDataExport -> Int

hash :: StartSupportDataExport -> Int

ToJSON StartSupportDataExport

Methods

toJSON :: StartSupportDataExport -> Value

toEncoding :: StartSupportDataExport -> Encoding

toJSONList :: [StartSupportDataExport] -> Value

toEncodingList :: [StartSupportDataExport] -> Encoding

NFData StartSupportDataExport

Methods

rnf :: StartSupportDataExport -> ()

AWSRequest StartSupportDataExport

Associated Types

type Rs StartSupportDataExport :: *

Methods

request :: StartSupportDataExport -> Request StartSupportDataExport

response :: MonadResource m => Logger -> Service -> Proxy * StartSupportDataExport -> ClientResponse -> m (Response StartSupportDataExport)

ToPath StartSupportDataExport

Methods

toPath :: StartSupportDataExport -> ByteString

ToHeaders StartSupportDataExport

Methods

toHeaders :: StartSupportDataExport -> [Header]

ToQuery StartSupportDataExport

Methods

toQuery :: StartSupportDataExport -> QueryString

type Rep StartSupportDataExport

type Rep StartSupportDataExport = D1 (MetaData "StartSupportDataExport" "Network.AWS.MarketplaceAnalytics.StartSupportDataExport" "amazonka-marketplace-analytics-1.4.5-FeuvBPhESkYBAXaiSFe930" False) (C1 (MetaCons "StartSupportDataExport'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ssdeCustomerDefinedValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ssdeDestinationS3Prefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ssdeDataSetType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SupportDataSetType)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ssdeFromDate") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 POSIX)) (S1 (MetaSel (Just Symbol "_ssdeRoleNameARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ssdeDestinationS3BucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ssdeSnsTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs StartSupportDataExport

type Rs StartSupportDataExport = StartSupportDataExportResponse

Request Lenses

ssdeCustomerDefinedValues :: Lens' StartSupportDataExport (HashMap Text Text)

(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.

ssdeDestinationS3Prefix :: Lens' StartSupportDataExport (Maybe Text)

(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefixmydatasets", the output file "outputfile" would be published to "s3:mybucketmyprefixmydatasetsoutputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.

ssdeDataSetType :: Lens' StartSupportDataExport SupportDataSetType

Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time. Currently, only the test_customer_support_contacts_data value is supported * customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter. * test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

ssdeFromDate :: Lens' StartSupportDataExport UTCTime

The start date from which to retrieve the data set. This parameter only affects the customer_support_contacts_data data set type.

ssdeRoleNameARN :: Lens' StartSupportDataExport Text

The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

ssdeDestinationS3BucketName :: Lens' StartSupportDataExport Text

The name (friendly name, not ARN) of the destination S3 bucket.

ssdeSnsTopicARN :: Lens' StartSupportDataExport Text

Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

Destructuring the Response

startSupportDataExportResponse

Arguments

:: Int

ssdersResponseStatus

-> StartSupportDataExportResponse

Creates a value of StartSupportDataExportResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ssdersDataSetRequestId - A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be used to correlate a request with notifications from the SNS topic.
• ssdersResponseStatus - -- | The response status code.

data StartSupportDataExportResponse

Container for the result of the StartSupportDataExport operation.

See: startSupportDataExportResponse smart constructor.

Instances

Eq StartSupportDataExportResponse

Methods

(==) :: StartSupportDataExportResponse -> StartSupportDataExportResponse -> Bool

(/=) :: StartSupportDataExportResponse -> StartSupportDataExportResponse -> Bool

Data StartSupportDataExportResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartSupportDataExportResponse -> c StartSupportDataExportResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartSupportDataExportResponse

toConstr :: StartSupportDataExportResponse -> Constr

dataTypeOf :: StartSupportDataExportResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartSupportDataExportResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartSupportDataExportResponse)

gmapT :: (forall b. Data b => b -> b) -> StartSupportDataExportResponse -> StartSupportDataExportResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartSupportDataExportResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartSupportDataExportResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> StartSupportDataExportResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartSupportDataExportResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartSupportDataExportResponse -> m StartSupportDataExportResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartSupportDataExportResponse -> m StartSupportDataExportResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartSupportDataExportResponse -> m StartSupportDataExportResponse

Read StartSupportDataExportResponse

Methods

readsPrec :: Int -> ReadS StartSupportDataExportResponse

readList :: ReadS [StartSupportDataExportResponse]

readPrec :: ReadPrec StartSupportDataExportResponse

readListPrec :: ReadPrec [StartSupportDataExportResponse]

Show StartSupportDataExportResponse

Methods

showsPrec :: Int -> StartSupportDataExportResponse -> ShowS

show :: StartSupportDataExportResponse -> String

showList :: [StartSupportDataExportResponse] -> ShowS

Generic StartSupportDataExportResponse

Associated Types

type Rep StartSupportDataExportResponse :: * -> *

Methods

from :: StartSupportDataExportResponse -> Rep StartSupportDataExportResponse x

to :: Rep StartSupportDataExportResponse x -> StartSupportDataExportResponse

NFData StartSupportDataExportResponse

Methods

rnf :: StartSupportDataExportResponse -> ()

type Rep StartSupportDataExportResponse

type Rep StartSupportDataExportResponse = D1 (MetaData "StartSupportDataExportResponse" "Network.AWS.MarketplaceAnalytics.StartSupportDataExport" "amazonka-marketplace-analytics-1.4.5-FeuvBPhESkYBAXaiSFe930" False) (C1 (MetaCons "StartSupportDataExportResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ssdersDataSetRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ssdersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

ssdersDataSetRequestId :: Lens' StartSupportDataExportResponse (Maybe Text)

A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be used to correlate a request with notifications from the SNS topic.

ssdersResponseStatus :: Lens' StartSupportDataExportResponse Int

• - | The response status code.