/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ApiGateway::PutGatewayResponse

NAME

Paws::ApiGateway::PutGatewayResponse - Arguments for method PutGatewayResponse on Paws::ApiGateway

DESCRIPTION

This class represents the parameters used for calling the method PutGatewayResponse on the Amazon API Gateway service. Use the attributes of this class as arguments to method PutGatewayResponse.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutGatewayResponse.

SYNOPSIS

my $apigateway = Paws->service('ApiGateway');
my $GatewayResponse = $apigateway->PutGatewayResponse(
  ResponseType       => 'DEFAULT_4XX',
  RestApiId          => 'MyString',
  ResponseParameters => { 'MyString' => 'MyString', },    # OPTIONAL
  ResponseTemplates  => { 'MyString' => 'MyString', },    # OPTIONAL
  StatusCode         => 'MyStatusCode',                   # OPTIONAL
);

# Results:
my $DefaultResponse    = $GatewayResponse->DefaultResponse;
my $ResponseParameters = $GatewayResponse->ResponseParameters;
my $ResponseTemplates  = $GatewayResponse->ResponseTemplates;
my $ResponseType       = $GatewayResponse->ResponseType;
my $StatusCode         = $GatewayResponse->StatusCode;

# Returns a L<Paws::ApiGateway::GatewayResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/apigateway/PutGatewayResponse

ATTRIBUTES

ResponseParameters => Paws::ApiGateway::MapOfStringToString

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

ResponseTemplates => Paws::ApiGateway::MapOfStringToString

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

REQUIRED ResponseType => Str

[Required]

The response type of the associated GatewayResponse. Valid values are

  • ACCESS_DENIED

  • API_CONFIGURATION_ERROR

  • AUTHORIZER_FAILURE

  • AUTHORIZER_CONFIGURATION_ERROR

  • BAD_REQUEST_PARAMETERS

  • BAD_REQUEST_BODY

  • DEFAULT_4XX

  • DEFAULT_5XX

  • EXPIRED_TOKEN

  • INVALID_SIGNATURE

  • INTEGRATION_FAILURE

  • INTEGRATION_TIMEOUT

  • INVALID_API_KEY

  • MISSING_AUTHENTICATION_TOKEN

  • QUOTA_EXCEEDED

  • REQUEST_TOO_LARGE

  • RESOURCE_NOT_FOUND

  • THROTTLED

  • UNAUTHORIZED

  • UNSUPPORTED_MEDIA_TYPE

Valid values are: "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

StatusCode => Str

The HTTP status code of the GatewayResponse.

SEE ALSO

This class forms part of Paws, documenting arguments for method PutGatewayResponse in Paws::ApiGateway

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues