Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. apigatewayv2
  6. getPortalProduct

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

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.apigatewayv2.getPortalProduct

aws-native logo aws-native logo

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

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Represents a portal product in Amazon API Gateway V2, which is a logical grouping of APIs that can be published in a developer portal.

    Using getPortalProduct

    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 getPortalProduct(args: GetPortalProductArgs, opts?: InvokeOptions): Promise<GetPortalProductResult>
function getPortalProductOutput(args: GetPortalProductOutputArgs, opts?: InvokeOutputOptions): Output<GetPortalProductResult>
    def get_portal_product(portal_product_arn: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPortalProductResult
def get_portal_product_output(portal_product_arn: pulumi.Input[Optional[str]] = None,
                       opts: Optional[InvokeOutputOptions] = None) -> Output[GetPortalProductResult]
    func LookupPortalProduct(ctx *Context, args *LookupPortalProductArgs, opts ...InvokeOption) (*LookupPortalProductResult, error)
func LookupPortalProductOutput(ctx *Context, args *LookupPortalProductOutputArgs, opts ...InvokeOption) LookupPortalProductResultOutput

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

    public static class GetPortalProduct 
{
    public static Task<GetPortalProductResult> InvokeAsync(GetPortalProductArgs args, InvokeOptions? opts = null)
    public static Output<GetPortalProductResult> Invoke(GetPortalProductInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPortalProductResult> Invoke(GetPortalProductInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetPortalProductResult> getPortalProduct(GetPortalProductArgs args, InvokeOptions options)
public static Output<GetPortalProductResult> getPortalProduct(GetPortalProductArgs args, InvokeOptions options)
public static Output<GetPortalProductResult> getPortalProduct(GetPortalProductArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:apigatewayv2:getPortalProduct
  arguments:
    # arguments dictionary
    data "aws-native_apigatewayv2_get_portal_product" "name" {
    # arguments
}

    The following arguments are supported:

    PortalProductArn string
    The ARN of the portal product.
    PortalProductArn string
    The ARN of the portal product.
    portal_product_arn string
    The ARN of the portal product.
    portalProductArn String
    The ARN of the portal product.
    portalProductArn string
    The ARN of the portal product.
    portal_product_arn str
    The ARN of the portal product.
    portalProductArn String
    The ARN of the portal product.

    getPortalProduct Result

    The following output properties are available:

    Description string
    A description of the portal product.
    DisplayName string
    The name of the portal product as it appears in a published portal.
    LastModified string
    The timestamp when the portal product was last modified.
    PortalProductArn string
    The ARN of the portal product.
    PortalProductId string
    The portal product identifier.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The collection of tags associated with the portal product.
    Description string
    A description of the portal product.
    DisplayName string
    The name of the portal product as it appears in a published portal.
    LastModified string
    The timestamp when the portal product was last modified.
    PortalProductArn string
    The ARN of the portal product.
    PortalProductId string
    The portal product identifier.
    Tags Tag
    The collection of tags associated with the portal product.
    description string
    A description of the portal product.
    display_name string
    The name of the portal product as it appears in a published portal.
    last_modified string
    The timestamp when the portal product was last modified.
    portal_product_arn string
    The ARN of the portal product.
    portal_product_id string
    The portal product identifier.
    tags list(object)
    The collection of tags associated with the portal product.
    description String
    A description of the portal product.
    displayName String
    The name of the portal product as it appears in a published portal.
    lastModified String
    The timestamp when the portal product was last modified.
    portalProductArn String
    The ARN of the portal product.
    portalProductId String
    The portal product identifier.
    tags List<Tag>
    The collection of tags associated with the portal product.
    description string
    A description of the portal product.
    displayName string
    The name of the portal product as it appears in a published portal.
    lastModified string
    The timestamp when the portal product was last modified.
    portalProductArn string
    The ARN of the portal product.
    portalProductId string
    The portal product identifier.
    tags Tag[]
    The collection of tags associated with the portal product.
    description str
    A description of the portal product.
    display_name str
    The name of the portal product as it appears in a published portal.
    last_modified str
    The timestamp when the portal product was last modified.
    portal_product_arn str
    The ARN of the portal product.
    portal_product_id str
    The portal product identifier.
    tags Sequence[root_Tag]
    The collection of tags associated with the portal product.
    description String
    A description of the portal product.
    displayName String
    The name of the portal product as it appears in a published portal.
    lastModified String
    The timestamp when the portal product was last modified.
    portalProductArn String
    The ARN of the portal product.
    portalProductId String
    The portal product identifier.
    tags List<Property Map>
    The collection of tags associated with the portal product.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.76.0
    published on Monday, Aug 24, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial