1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package marketplacecommerceanalytics
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/marketplacecommerceanalytics/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// 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.
func (c *Client) StartSupportDataExport(ctx context.Context, params *StartSupportDataExportInput, optFns ...func(*Options)) (*StartSupportDataExportOutput, error) {
if params == nil {
params = &StartSupportDataExportInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartSupportDataExport", params, optFns, c.addOperationStartSupportDataExportMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartSupportDataExportOutput)
out.ResultMetadata = metadata
return out, nil
}
// Container for the parameters to the StartSupportDataExport operation.
type StartSupportDataExportInput struct {
// 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, Product
// Code, 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.
//
// *
// 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
//
// This member is required.
DataSetType types.SupportDataSetType
// The name (friendly name, not ARN) of the destination S3 bucket.
//
// This member is required.
DestinationS3BucketName *string
// The start date from which to retrieve the data set in UTC. This parameter only
// affects the customer_support_contacts_data data set type.
//
// This member is required.
FromDate *time.Time
// The Amazon Resource Name (ARN) of the Role with an attached permissions policy
// to interact with the provided AWS services.
//
// This member is required.
RoleNameArn *string
// 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.
//
// This member is required.
SnsTopicArn *string
// (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS
// notification message and the data set metadata file.
CustomerDefinedValues map[string]string
// (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 "myprefix/mydatasets", the output file "outputfile"
// would be published to "s3://mybucket/myprefix/mydatasets/outputfile". 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.
DestinationS3Prefix *string
noSmithyDocumentSerde
}
// Container for the result of the StartSupportDataExport operation.
type StartSupportDataExportOutput struct {
// 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.
DataSetRequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartSupportDataExportMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpStartSupportDataExport{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpStartSupportDataExport{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpStartSupportDataExportValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartSupportDataExport(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opStartSupportDataExport(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "marketplacecommerceanalytics",
OperationName: "StartSupportDataExport",
}
}
|