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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package apigatewayv2
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/apigatewayv2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Gets a Route.
func (c *Client) GetRoute(ctx context.Context, params *GetRouteInput, optFns ...func(*Options)) (*GetRouteOutput, error) {
if params == nil {
params = &GetRouteInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetRoute", params, optFns, c.addOperationGetRouteMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetRouteOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetRouteInput struct {
// The API identifier.
//
// This member is required.
ApiId *string
// The route ID.
//
// This member is required.
RouteId *string
noSmithyDocumentSerde
}
type GetRouteOutput struct {
// Specifies whether a route is managed by API Gateway. If you created an API
// using quick create, the $default route is managed by API Gateway. You can't
// modify the $default route key.
ApiGatewayManaged *bool
// Specifies whether an API key is required for this route. Supported only for
// WebSocket APIs.
ApiKeyRequired *bool
// A list of authorization scopes configured on a route. The scopes are used with
// a JWT authorizer to authorize the method invocation. The authorization works by
// matching the route scopes against the scopes parsed from the access token in the
// incoming request. The method invocation is authorized if any route scope matches
// a claimed scope in the access token. Otherwise, the invocation is not
// authorized. When the route scope is configured, the client must provide an
// access token instead of an identity token for authorization purposes.
AuthorizationScopes []string
// The authorization type for the route. For WebSocket APIs, valid values are NONE
// for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a
// Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for
// using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for
// using a Lambda authorizer.
AuthorizationType types.AuthorizationType
// The identifier of the Authorizer resource to be associated with this route. The
// authorizer identifier is generated by API Gateway when you created the
// authorizer.
AuthorizerId *string
// The model selection expression for the route. Supported only for WebSocket APIs.
ModelSelectionExpression *string
// The operation name for the route.
OperationName *string
// The request models for the route. Supported only for WebSocket APIs.
RequestModels map[string]string
// The request parameters for the route. Supported only for WebSocket APIs.
RequestParameters map[string]types.ParameterConstraints
// The route ID.
RouteId *string
// The route key for the route.
RouteKey *string
// The route response selection expression for the route. Supported only for
// WebSocket APIs.
RouteResponseSelectionExpression *string
// The target for the route.
Target *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetRouteMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetRoute{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetRoute{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetRoute"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpGetRouteValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetRoute(options.Region), middleware.Before); err != nil {
return err
}
if err = 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_opGetRoute(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetRoute",
}
}
|