Struct PutMethodOutput

#[non_exhaustive]
pub struct PutMethodOutput {
    pub http_method: Option<String>,
    pub authorization_type: Option<String>,
    pub authorizer_id: Option<String>,
    pub api_key_required: Option<bool>,
    pub request_validator_id: Option<String>,
    pub operation_name: Option<String>,
    pub request_parameters: Option<HashMap<String, bool>>,
    pub request_models: Option<HashMap<String, String>>,
    pub method_responses: Option<HashMap<String, MethodResponse>>,
    pub method_integration: Option<Integration>,
    pub authorization_scopes: Option<Vec<String>>,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

http_method: Option<String>

The method's HTTP verb.

authorization_type: Option<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.

authorizer_id: Option<String>

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

api_key_required: Option<bool>

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

request_validator_id: Option<String>

The identifier of a RequestValidator for request validation.

operation_name: Option<String>

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.

request_parameters: Option<HashMap<String, bool>>

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.

request_models: Option<HashMap<String, 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).

method_responses: Option<HashMap<String, MethodResponse>>

Gets a method response associated with a given HTTP status code.

method_integration: Option<Integration>

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.

authorization_scopes: Option<Vec<String>>

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.

Implementations

impl PutMethodOutput

pub fn http_method(&self) -> Option<&str>

The method's HTTP verb.

pub fn authorization_type(&self) -> Option<&str>

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.

pub fn authorizer_id(&self) -> Option<&str>

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

pub fn api_key_required(&self) -> Option<bool>

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

pub fn request_validator_id(&self) -> Option<&str>

The identifier of a RequestValidator for request validation.

pub fn operation_name(&self) -> Option<&str>

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.

pub fn request_parameters(&self) -> Option<&HashMap<String, bool>>

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.

pub fn request_models(&self) -> Option<&HashMap<String, 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).

pub fn method_responses(&self) -> Option<&HashMap<String, MethodResponse>>

Gets a method response associated with a given HTTP status code.

pub fn method_integration(&self) -> Option<&Integration>

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.

pub fn authorization_scopes(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .authorization_scopes.is_none().

impl PutMethodOutput

pub fn builder() -> PutMethodOutputBuilder

Creates a new builder-style object to manufacture PutMethodOutput.

Trait Implementations

impl Clone for PutMethodOutput

fn clone(&self) -> PutMethodOutput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutMethodOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PutMethodOutput

fn eq(&self, other: &PutMethodOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for PutMethodOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for PutMethodOutput