Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. getGatewayResponse

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.getGatewayResponse

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see API Gateway Responses in the API Gateway Developer Guide.

    Using getGatewayResponse

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGatewayResponse(args: GetGatewayResponseArgs, opts?: InvokeOptions): Promise<GetGatewayResponseResult>
function getGatewayResponseOutput(args: GetGatewayResponseOutputArgs, opts?: InvokeOptions): Output<GetGatewayResponseResult>
    def get_gateway_response(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetGatewayResponseResult
def get_gateway_response_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResponseResult]
    func LookupGatewayResponse(ctx *Context, args *LookupGatewayResponseArgs, opts ...InvokeOption) (*LookupGatewayResponseResult, error)
func LookupGatewayResponseOutput(ctx *Context, args *LookupGatewayResponseOutputArgs, opts ...InvokeOption) LookupGatewayResponseResultOutput

    > Note: This function is named LookupGatewayResponse in the Go SDK.

    public static class GetGatewayResponse 
{
    public static Task<GetGatewayResponseResult> InvokeAsync(GetGatewayResponseArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayResponseResult> Invoke(GetGatewayResponseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayResponseResult> getGatewayResponse(GetGatewayResponseArgs args, InvokeOptions options)
public static Output<GetGatewayResponseResult> getGatewayResponse(GetGatewayResponseArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:apigateway:getGatewayResponse
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID for the gateway response. For example: abc123 .
    Id string
    The ID for the gateway response. For example: abc123 .
    id String
    The ID for the gateway response. For example: abc123 .
    id string
    The ID for the gateway response. For example: abc123 .
    id str
    The ID for the gateway response. For example: abc123 .
    id String
    The ID for the gateway response. For example: abc123 .

    getGatewayResponse Result

    The following output properties are available:

    Id string
    The ID for the gateway response. For example: abc123 .
    ResponseParameters Dictionary<string, string>
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    ResponseTemplates Dictionary<string, string>
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    StatusCode string
    The HTTP status code for this GatewayResponse.
    Id string
    The ID for the gateway response. For example: abc123 .
    ResponseParameters map[string]string
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    ResponseTemplates map[string]string
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    StatusCode string
    The HTTP status code for this GatewayResponse.
    id String
    The ID for the gateway response. For example: abc123 .
    responseParameters Map<String,String>
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    responseTemplates Map<String,String>
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    statusCode String
    The HTTP status code for this GatewayResponse.
    id string
    The ID for the gateway response. For example: abc123 .
    responseParameters {[key: string]: string}
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    responseTemplates {[key: string]: string}
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    statusCode string
    The HTTP status code for this GatewayResponse.
    id str
    The ID for the gateway response. For example: abc123 .
    response_parameters Mapping[str, str]
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    response_templates Mapping[str, str]
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    status_code str
    The HTTP status code for this GatewayResponse.
    id String
    The ID for the gateway response. For example: abc123 .
    responseParameters Map<String>
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    responseTemplates Map<String>
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    statusCode String
    The HTTP status code for this GatewayResponse.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native