Skip to content

GetPortalResponse

Source code in docs_src/capo_apigatewayv2/types/get_portal_response.py
class GetPortalResponse(TypedDict, closed=True):
    authorization: NotRequired["capo_apigatewayv2.types.authorization.Authorization"]
    """<p>The authorization for the portal.</p>"""
    endpoint_configuration: NotRequired[
        "capo_apigatewayv2.types.endpoint_configuration_response.EndpointConfigurationResponse"
    ]
    """<p>The endpoint configuration.</p>"""
    included_portal_product_arns: NotRequired[
        "capo_apigatewayv2.types.__list_of__string_min20_max2048.__listOf__stringMin20Max2048"
    ]
    """<p>The ARNs of the portal products included in the portal.</p>"""
    last_modified: NotRequired[
        "capo_apigatewayv2.types.__timestamp_iso8601.__timestampIso8601"
    ]
    """<p>The timestamp when the portal was last modified.</p>"""
    last_published: NotRequired[
        "capo_apigatewayv2.types.__timestamp_iso8601.__timestampIso8601"
    ]
    """<p>The timestamp when the portal was last published.</p>"""
    last_published_description: NotRequired[
        "capo_apigatewayv2.types.__string_min0_max1024.__stringMin0Max1024"
    ]
    """<p>The publish description used when the portal was last published.</p>"""
    portal_arn: NotRequired[
        "capo_apigatewayv2.types.__string_min20_max2048.__stringMin20Max2048"
    ]
    """<p>The ARN of the portal.</p>"""
    portal_content: NotRequired["capo_apigatewayv2.types.portal_content.PortalContent"]
    """<p>Contains the content that is visible to portal consumers including the themes, display names, and description.</p>"""
    portal_id: NotRequired[
        "capo_apigatewayv2.types.__string_min10_max30_pattern_az09.__stringMin10Max30PatternAZ09"
    ]
    """<p>The portal identifier.</p>"""
    preview: NotRequired["capo_apigatewayv2.types.preview.Preview"]
    """<p>Represents the preview endpoint and the any possible error messages during preview generation.</p>"""
    publish_status: NotRequired["capo_apigatewayv2.types.publish_status.PublishStatus"]
    """<p>The publish status of a portal.</p>"""
    rum_app_monitor_name: NotRequired[
        "capo_apigatewayv2.types.__string_min0_max255.__stringMin0Max255"
    ]
    """<p>The CloudWatch RUM app monitor name.</p>"""
    status_exception: NotRequired[
        "capo_apigatewayv2.types.status_exception.StatusException"
    ]
    """<p>The status exception information.</p>"""
    tags: NotRequired["capo_apigatewayv2.types.tags.Tags"]
    """<p>The collection of tags. Each tag element is associated with a given resource.</p>"""

authorization instance-attribute

authorization: NotRequired[Authorization]

The authorization for the portal.

endpoint_configuration instance-attribute

endpoint_configuration: NotRequired[EndpointConfigurationResponse]

The endpoint configuration.

included_portal_product_arns instance-attribute

included_portal_product_arns: NotRequired[__listOf__stringMin20Max2048]

The ARNs of the portal products included in the portal.

last_modified instance-attribute

last_modified: NotRequired[__timestampIso8601]

The timestamp when the portal was last modified.

last_published instance-attribute

last_published: NotRequired[__timestampIso8601]

The timestamp when the portal was last published.

last_published_description instance-attribute

last_published_description: NotRequired[__stringMin0Max1024]

The publish description used when the portal was last published.

portal_arn instance-attribute

portal_arn: NotRequired[__stringMin20Max2048]

The ARN of the portal.

portal_content instance-attribute

portal_content: NotRequired[PortalContent]

Contains the content that is visible to portal consumers including the themes, display names, and description.

portal_id instance-attribute

portal_id: NotRequired[__stringMin10Max30PatternAZ09]

The portal identifier.

preview instance-attribute

preview: NotRequired[Preview]

Represents the preview endpoint and the any possible error messages during preview generation.

publish_status instance-attribute

publish_status: NotRequired[PublishStatus]

The publish status of a portal.

rum_app_monitor_name instance-attribute

rum_app_monitor_name: NotRequired[__stringMin0Max255]

The CloudWatch RUM app monitor name.

status_exception instance-attribute

status_exception: NotRequired[StatusException]

The status exception information.

tags instance-attribute

tags: NotRequired[Tags]

The collection of tags. Each tag element is associated with a given resource.