Method ¶

class Method(TypedDict, closed=True):
    http_method: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The method's HTTP verb.</p>"""
    authorization_type: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>"""
    authorizer_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The identifier of an Authorizer to use on this method. The <code>authorizationType</code> must be <code>CUSTOM</code>.</p>"""
    api_key_required: NotRequired[
        "capo_api_gateway.types.nullable_boolean.NullableBoolean"
    ]
    """<p>A boolean flag specifying whether a valid ApiKey is required to invoke this method.</p>"""
    request_validator_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The identifier of a RequestValidator for request validation.</p>"""
    operation_name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.</p>"""
    request_parameters: NotRequired[
        "capo_api_gateway.types.map_of_string_to_boolean.MapOfStringToBoolean"
    ]
    """<p>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 <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.</p>"""
    request_models: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>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).</p>"""
    method_responses: NotRequired[
        "capo_api_gateway.types.map_of_method_response.MapOfMethodResponse"
    ]
    """<p>Gets a method response associated with a given HTTP status code. </p>"""
    method_integration: NotRequired["capo_api_gateway.types.integration.Integration"]
    """<p>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.</p>"""
    authorization_scopes: NotRequired[
        "capo_api_gateway.types.list_of_string.ListOfString"
    ]
    """<p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> 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.</p>"""