Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.apigateway.getModel
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::ApiGateway::Model
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(name: Optional[str] = None,
rest_api_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetModelResult
def get_model_output(name: Optional[pulumi.Input[str]] = None,
rest_api_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:apigateway:getModel
arguments:
# arguments dictionaryThe following arguments are supported:
- name str
A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
- rest_
api_ strid The ID of a REST API with which to associate this model.
getModel Result
The following output properties are available:
- Description string
A description that identifies this model.
- Schema object
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- Description string
A description that identifies this model.
- Schema interface{}
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- description String
A description that identifies this model.
- schema Object
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- description string
A description that identifies this model.
- schema any
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- description str
A description that identifies this model.
- schema Any
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- description String
A description that identifies this model.
- schema Any
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.