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 217 218 219 220 221 222 223 224 225
|
// 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 an Authorizer.
func (c *Client) GetAuthorizer(ctx context.Context, params *GetAuthorizerInput, optFns ...func(*Options)) (*GetAuthorizerOutput, error) {
if params == nil {
params = &GetAuthorizerInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetAuthorizer", params, optFns, c.addOperationGetAuthorizerMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetAuthorizerOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetAuthorizerInput struct {
// The API identifier.
//
// This member is required.
ApiId *string
// The authorizer identifier.
//
// This member is required.
AuthorizerId *string
noSmithyDocumentSerde
}
type GetAuthorizerOutput struct {
// Specifies the required credentials as an IAM role for API Gateway to invoke the
// authorizer. To specify an IAM role for API Gateway to assume, use the role's
// Amazon Resource Name (ARN). To use resource-based permissions on the Lambda
// function, don't specify this parameter. Supported only for REQUEST authorizers.
AuthorizerCredentialsArn *string
// The authorizer identifier.
AuthorizerId *string
// Specifies the format of the payload sent to an HTTP API Lambda authorizer.
// Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To
// learn more, see [Working with AWS Lambda authorizers for HTTP APIs].
//
// [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
AuthorizerPayloadFormatVersion *string
// The time to live (TTL) for cached authorizer results, in seconds. If it equals
// 0, authorization caching is disabled. If it is greater than 0, API Gateway
// caches authorizer responses. The maximum value is 3600, or 1 hour. Supported
// only for HTTP API Lambda authorizers.
AuthorizerResultTtlInSeconds *int32
// The authorizer type. Specify REQUEST for a Lambda function using incoming
// request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP
// APIs).
AuthorizerType types.AuthorizerType
// The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers,
// this must be a well-formed Lambda function URI, for example,
// arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
// In general, the URI has this form:
// arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the
// same as the region hosting the Lambda function, path indicates that the
// remaining substring in the URI should be treated as the path to the resource,
// including the initial /. For Lambda functions, this is usually of the form
// /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST
// authorizers.
AuthorizerUri *string
// Specifies whether a Lambda authorizer returns a response in a simple format. If
// enabled, the Lambda authorizer can return a boolean value instead of an IAM
// policy. Supported only for HTTP APIs. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs]
//
// [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
EnableSimpleResponses *bool
// The identity source for which authorization is requested.
//
// For a REQUEST authorizer, this is optional. The value is a set of one or more
// mapping expressions of the specified request parameters. The identity source can
// be headers, query string parameters, stage variables, and context parameters.
// For example, if an Auth header and a Name query string parameter are defined as
// identity sources, this value is route.request.header.Auth,
// route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection
// expressions prefixed with $, for example, $request.header.Auth,
// $request.querystring.Name. These parameters are used to perform runtime
// validation for Lambda-based authorizers by verifying all of the identity-related
// request parameters are present in the request, not null, and non-empty. Only
// when this is true does the authorizer invoke the authorizer Lambda function.
// Otherwise, it returns a 401 Unauthorized response without calling the Lambda
// function. For HTTP APIs, identity sources are also used as the cache key when
// caching is enabled. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs].
//
// For JWT, a single entry that specifies where to extract the JSON Web Token
// (JWT) from inbound requests. Currently only header-based and query
// parameter-based selections are supported, for example
// $request.header.Authorization.
//
// [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
IdentitySource []string
// The validation expression does not apply to the REQUEST authorizer.
IdentityValidationExpression *string
// Represents the configuration of a JWT authorizer. Required for the JWT
// authorizer type. Supported only for HTTP APIs.
JwtConfiguration *types.JWTConfiguration
// The name of the authorizer.
Name *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetAuthorizerMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetAuthorizer{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetAuthorizer{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetAuthorizer"); 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 = addOpGetAuthorizerValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetAuthorizer(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_opGetAuthorizer(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetAuthorizer",
}
}
|