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
|
// 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"
)
// Describe an existing Method resource.
func (c *Client) GetMethod(ctx context.Context, params *GetMethodInput, optFns ...func(*Options)) (*GetMethodOutput, error) {
if params == nil {
params = &GetMethodInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetMethod", params, optFns, c.addOperationGetMethodMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetMethodOutput)
out.ResultMetadata = metadata
return out, nil
}
// Request to describe an existing Method resource.
type GetMethodInput struct {
// Specifies the method request's HTTP method type.
//
// This member is required.
HttpMethod *string
// The Resource identifier for the Method resource.
//
// This member is required.
ResourceId *string
// The string identifier of the associated RestApi.
//
// This member is required.
RestApiId *string
noSmithyDocumentSerde
}
// Represents a client-facing interface by which the client calls the API to
// access back-end resources. A Method resource is integrated with an Integration
// resource. Both consist of a request and one or more responses. The method
// request takes the client input that is passed to the back end through the
// integration request. A method response returns the output from the back end to
// the client through an integration response. A method request is embodied in a
// Method resource, whereas an integration request is embodied in an Integration
// resource. On the other hand, a method response is represented by a
// MethodResponse resource, whereas an integration response is represented by an
// IntegrationResponse resource.
type GetMethodOutput struct {
// A boolean flag specifying whether a valid ApiKey is required to invoke this
// method.
ApiKeyRequired *bool
// A list of authorization scopes configured on the method. The scopes are used
// with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The
// authorization works by matching the method scopes against the scopes parsed from
// the access token in the incoming request. The method invocation is authorized if
// any method scopes matches a claimed scope in the access token. Otherwise, the
// invocation is not authorized. When the method scope is configured, the client
// must provide an access token instead of an identity token for authorization
// purposes.
AuthorizationScopes []string
// The method's authorization type. Valid values are NONE for open access, AWS_IAM
// for using AWS IAM permissions, CUSTOM for using a custom authorizer, or
// COGNITO_USER_POOLS for using a Cognito user pool.
AuthorizationType *string
// The identifier of an Authorizer to use on this method. The authorizationType
// must be CUSTOM .
AuthorizerId *string
// The method's HTTP verb.
HttpMethod *string
// Gets the method's integration responsible for passing the client-submitted
// request to the back end and performing necessary transformations to make the
// request compliant with the back end.
MethodIntegration *types.Integration
// Gets a method response associated with a given HTTP status code.
MethodResponses map[string]types.MethodResponse
// A human-friendly operation identifier for the method. For example, you can
// assign the operationName of ListPets for the GET /pets method in the PetStore
// example.
OperationName *string
// A key-value map specifying data schemas, represented by Model resources, (as
// the mapped value) of the request payloads of given content types (as the mapping
// key).
RequestModels map[string]string
// A key-value map defining required or optional method request parameters that
// can be accepted by API Gateway. A key is a method request parameter name
// matching the pattern of method.request.{location}.{name} , where location is
// querystring , path , or header and name is a valid and unique parameter name.
// The value associated with the key is a Boolean flag indicating whether the
// parameter is required ( true ) or optional ( false ). The method request
// parameter names defined here are available in Integration to be mapped to
// integration request parameters or templates.
RequestParameters map[string]bool
// The identifier of a RequestValidator for request validation.
RequestValidatorId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetMethodMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetMethod{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetMethod{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetMethod"); 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 = addOpGetMethodValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetMethod(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_opGetMethod(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetMethod",
}
}
|