Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigatewayv2
  5. getModel

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.getModel

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGatewayV2::Model resource updates data model for a WebSocket API. For more information, see Model Selection Expressions in the API Gateway Developer Guide.

    Using getModel

    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 getModel(args: GetModelArgs, opts?: InvokeOptions): Promise<GetModelResult>
function getModelOutput(args: GetModelOutputArgs, opts?: InvokeOptions): Output<GetModelResult>
    def get_model(api_id: Optional[str] = None,
              model_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetModelResult
def get_model_output(api_id: Optional[pulumi.Input[str]] = None,
              model_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetModelResult]
    func LookupModel(ctx *Context, args *LookupModelArgs, opts ...InvokeOption) (*LookupModelResult, error)
func LookupModelOutput(ctx *Context, args *LookupModelOutputArgs, opts ...InvokeOption) LookupModelResultOutput

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

    public static class GetModel 
{
    public static Task<GetModelResult> InvokeAsync(GetModelArgs args, InvokeOptions? opts = null)
    public static Output<GetModelResult> Invoke(GetModelInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetModelResult> getModel(GetModelArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:apigatewayv2:getModel
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiId string
    The API identifier.
    ModelId string
    The model ID.
    ApiId string
    The API identifier.
    ModelId string
    The model ID.
    apiId String
    The API identifier.
    modelId String
    The model ID.
    apiId string
    The API identifier.
    modelId string
    The model ID.
    api_id str
    The API identifier.
    model_id str
    The model ID.
    apiId String
    The API identifier.
    modelId String
    The model ID.

    getModel Result

    The following output properties are available:

    ContentType string
    The content-type for the model, for example, "application/json".
    Description string
    The description of the model.
    ModelId string
    The model ID.
    Name string
    The name of the model.
    Schema object

    The schema for the model. For application/json models, this should be JSON schema draft 4 model.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Model for more information about the expected schema for this property.

    ContentType string
    The content-type for the model, for example, "application/json".
    Description string
    The description of the model.
    ModelId string
    The model ID.
    Name string
    The name of the model.
    Schema interface{}

    The schema for the model. For application/json models, this should be JSON schema draft 4 model.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Model for more information about the expected schema for this property.

    contentType String
    The content-type for the model, for example, "application/json".
    description String
    The description of the model.
    modelId String
    The model ID.
    name String
    The name of the model.
    schema Object

    The schema for the model. For application/json models, this should be JSON schema draft 4 model.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Model for more information about the expected schema for this property.

    contentType string
    The content-type for the model, for example, "application/json".
    description string
    The description of the model.
    modelId string
    The model ID.
    name string
    The name of the model.
    schema any

    The schema for the model. For application/json models, this should be JSON schema draft 4 model.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Model for more information about the expected schema for this property.

    content_type str
    The content-type for the model, for example, "application/json".
    description str
    The description of the model.
    model_id str
    The model ID.
    name str
    The name of the model.
    schema Any

    The schema for the model. For application/json models, this should be JSON schema draft 4 model.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Model for more information about the expected schema for this property.

    contentType String
    The content-type for the model, for example, "application/json".
    description String
    The description of the model.
    modelId String
    The model ID.
    name String
    The name of the model.
    schema Any

    The schema for the model. For application/json models, this should be JSON schema draft 4 model.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Model for more information about the expected schema for this property.

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native