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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
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/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Starts an Asset Bundle export job. An Asset Bundle export job exports specified
// Amazon QuickSight assets. You can also choose to export any asset dependencies
// in the same job. Export jobs run asynchronously and can be polled with a
// DescribeAssetBundleExportJob API call. When a job is successfully completed, a
// download URL that contains the exported assets is returned. The URL is valid for
// 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call.
// Each Amazon QuickSight account can run up to 5 export jobs concurrently. The API
// caller must have the necessary permissions in their IAM role to access each
// resource before the resources can be exported.
func (c *Client) StartAssetBundleExportJob(ctx context.Context, params *StartAssetBundleExportJobInput, optFns ...func(*Options)) (*StartAssetBundleExportJobOutput, error) {
if params == nil {
params = &StartAssetBundleExportJobInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartAssetBundleExportJob", params, optFns, c.addOperationStartAssetBundleExportJobMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartAssetBundleExportJobOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartAssetBundleExportJobInput struct {
// The ID of the job. This ID is unique while the job is running. After the job is
// completed, you can reuse this ID for another job.
//
// This member is required.
AssetBundleExportJobId *string
// The ID of the Amazon Web Services account to export assets from.
//
// This member is required.
AwsAccountId *string
// The export data format.
//
// This member is required.
ExportFormat types.AssetBundleExportFormat
// An array of resource ARNs to export. The following resources are supported.
// - Analysis
// - Dashboard
// - DataSet
// - DataSource
// - RefreshSchedule
// - Theme
// - VPCConnection
// The API caller must have the necessary permissions in their IAM role to access
// each resource before the resources can be exported.
//
// This member is required.
ResourceArns []string
// An optional collection of structures that generate CloudFormation parameters to
// override the existing resource property values when the resource is exported to
// a new CloudFormation template. Use this field if the ExportFormat field of a
// StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON .
CloudFormationOverridePropertyConfiguration *types.AssetBundleCloudFormationOverridePropertyConfiguration
// A Boolean that determines whether all dependencies of each resource ARN are
// recursively exported with the job. For example, say you provided a Dashboard ARN
// to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE , any
// theme, dataset, and data source resource that is a dependency of the dashboard
// is also exported.
IncludeAllDependencies bool
// A Boolean that determines whether all permissions for each resource ARN are
// exported with the job. If you set IncludePermissions to TRUE , any permissions
// associated with each resource are exported.
IncludePermissions bool
// A Boolean that determines whether all tags for each resource ARN are exported
// with the job. If you set IncludeTags to TRUE , any tags associated with each
// resource are exported.
IncludeTags bool
// An optional parameter that determines which validation strategy to use for the
// export job. If StrictModeForAllResources is set to TRUE , strict validation for
// every error is enforced. If it is set to FALSE , validation is skipped for
// specific UI errors that are shown as warnings. The default value for
// StrictModeForAllResources is FALSE .
ValidationStrategy *types.AssetBundleExportJobValidationStrategy
noSmithyDocumentSerde
}
type StartAssetBundleExportJobOutput struct {
// The Amazon Resource Name (ARN) for the export job.
Arn *string
// The ID of the job. This ID is unique while the job is running. After the job is
// completed, you can reuse this ID for another job.
AssetBundleExportJobId *string
// The Amazon Web Services response ID for this operation.
RequestId *string
// The HTTP status of the response.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartAssetBundleExportJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpStartAssetBundleExportJob{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpStartAssetBundleExportJob{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "StartAssetBundleExportJob"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpStartAssetBundleExportJobValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartAssetBundleExportJob(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opStartAssetBundleExportJob(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "StartAssetBundleExportJob",
}
}
|