NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $apigateway = Paws->service('ApiGateway');
    my $TestInvokeMethodResponse = $apigateway->TestInvokeMethod(
      HttpMethod          => 'MyString',
      ResourceId          => 'MyString',
      RestApiId           => 'MyString',
      Body                => 'MyString',                              # OPTIONAL
      ClientCertificateId => 'MyString',                              # OPTIONAL
      Headers             => { 'MyString' => 'MyString', },           # OPTIONAL
      MultiValueHeaders   => { 'MyString' => [ 'MyString', ... ], },  # OPTIONAL
      PathWithQueryString => 'MyString',                              # OPTIONAL
      StageVariables      => { 'MyString' => 'MyString', },           # OPTIONAL
    );

    # Results:
    my $Body              = $TestInvokeMethodResponse->Body;
    my $Headers           = $TestInvokeMethodResponse->Headers;
    my $Latency           = $TestInvokeMethodResponse->Latency;
    my $Log               = $TestInvokeMethodResponse->Log;
    my $MultiValueHeaders = $TestInvokeMethodResponse->MultiValueHeaders;
    my $Status            = $TestInvokeMethodResponse->Status;

    # Returns a L<Paws::ApiGateway::TestInvokeMethodResponse> 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/TestInvokeMethod

ATTRIBUTES

Body => Str

The simulated request body of an incoming invocation request.

ClientCertificateId => Str

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

Headers => Paws::ApiGateway::MapOfStringToString

A key-value map of headers to simulate an incoming invocation request.

REQUIRED HttpMethod => Str

[Required] Specifies a test invoke method request's HTTP method.

MultiValueHeaders => Paws::ApiGateway::MapOfStringToList

The headers as a map from string to list of values to simulate an incoming invocation request.

PathWithQueryString => Str

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

REQUIRED ResourceId => Str

[Required] Specifies a test invoke method request's resource ID.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

StageVariables => Paws::ApiGateway::MapOfStringToString

A key-value map of stage variables to simulate an invocation on a deployed Stage.

SEE ALSO

This class forms part of Paws, documenting arguments for method TestInvokeMethod 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

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config