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 211 212 213 214 215 216
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package apigateway
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/apigateway/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// A feature of the API Gateway control service for creating a new API from an
// external API definition file.
func (c *Client) ImportRestApi(ctx context.Context, params *ImportRestApiInput, optFns ...func(*Options)) (*ImportRestApiOutput, error) {
if params == nil {
params = &ImportRestApiInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ImportRestApi", params, optFns, c.addOperationImportRestApiMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ImportRestApiOutput)
out.ResultMetadata = metadata
return out, nil
}
// A POST request to import an API to API Gateway using an input of an API
// definition file.
type ImportRestApiInput struct {
// The POST request body containing external API definitions. Currently, only
// OpenAPI definition JSON/YAML files are supported. The maximum size of the API
// definition file is 6MB.
//
// This member is required.
Body []byte
// A query parameter to indicate whether to rollback the API creation ( true ) or
// not ( false ) when a warning is encountered. The default value is false .
FailOnWarnings bool
// A key-value map of context-specific query string parameters specifying the
// behavior of different API importing operations. The following shows
// operation-specific parameters and their supported values. To exclude
// DocumentationParts from the import, set parameters as ignore=documentation . To
// configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE ,
// endpointConfigurationTypes=REGIONAL , or endpointConfigurationTypes=PRIVATE .
// The default endpoint type is EDGE . To handle imported basepath , set parameters
// as basepath=ignore , basepath=prepend or basepath=split .
Parameters map[string]string
noSmithyDocumentSerde
}
// Represents a REST API.
type ImportRestApiOutput struct {
// The source of the API key for metering requests according to a usage plan.
// Valid values are: > HEADER to read the API key from the X-API-Key header of a
// request. AUTHORIZER to read the API key from the UsageIdentifierKey from a
// custom authorizer.
ApiKeySource types.ApiKeySourceType
// The list of binary media types supported by the RestApi. By default, the
// RestApi supports only UTF-8-encoded text payloads.
BinaryMediaTypes []string
// The timestamp when the API was created.
CreatedDate *time.Time
// The API's description.
Description *string
// Specifies whether clients can invoke your API by using the default execute-api
// endpoint. By default, clients can invoke your API with the default
// https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
// clients use a custom domain name to invoke your API, disable the default
// endpoint.
DisableExecuteApiEndpoint bool
// The endpoint configuration of this RestApi showing the endpoint types of the
// API.
EndpointConfiguration *types.EndpointConfiguration
// The API's identifier. This identifier is unique across all of your APIs in API
// Gateway.
Id *string
// A nullable integer that is used to enable compression (with non-negative
// between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a
// null value) on an API. When compression is enabled, compression or decompression
// is not applied on the payload if the payload size is smaller than this value.
// Setting it to zero allows compression for any payload size.
MinimumCompressionSize *int32
// The API's name.
Name *string
// A stringified JSON policy document that applies to this RestApi regardless of
// the caller and Method configuration.
Policy *string
// The API's root resource ID.
RootResourceId *string
// The collection of tags. Each tag element is associated with a given resource.
Tags map[string]string
// A version identifier for the API.
Version *string
// The warning messages reported when failonwarnings is turned on during API
// import.
Warnings []string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationImportRestApiMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpImportRestApi{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpImportRestApi{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ImportRestApi"); 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 = addOpImportRestApiValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opImportRestApi(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 = addAcceptHeader(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_opImportRestApi(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ImportRestApi",
}
}
|