aws_sdk_apigatewayv2/client/
get_portal.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetPortal`](crate::operation::get_portal::builders::GetPortalFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`portal_id(impl Into<String>)`](crate::operation::get_portal::builders::GetPortalFluentBuilder::portal_id) / [`set_portal_id(Option<String>)`](crate::operation::get_portal::builders::GetPortalFluentBuilder::set_portal_id):<br>required: **true**<br><p>The portal identifier.</p><br>
7    /// - On success, responds with [`GetPortalOutput`](crate::operation::get_portal::GetPortalOutput) with field(s):
8    ///   - [`authorization(Option<Authorization>)`](crate::operation::get_portal::GetPortalOutput::authorization): <p>The authorization for the portal.</p>
9    ///   - [`endpoint_configuration(Option<EndpointConfigurationResponse>)`](crate::operation::get_portal::GetPortalOutput::endpoint_configuration): <p>The endpoint configuration.</p>
10    ///   - [`included_portal_product_arns(Option<Vec::<String>>)`](crate::operation::get_portal::GetPortalOutput::included_portal_product_arns): <p>The ARNs of the portal products included in the portal.</p>
11    ///   - [`last_modified(Option<DateTime>)`](crate::operation::get_portal::GetPortalOutput::last_modified): <p>The timestamp when the portal was last modified.</p>
12    ///   - [`last_published(Option<DateTime>)`](crate::operation::get_portal::GetPortalOutput::last_published): <p>The timestamp when the portal was last published.</p>
13    ///   - [`last_published_description(Option<String>)`](crate::operation::get_portal::GetPortalOutput::last_published_description): <p>The publish description used when the portal was last published.</p>
14    ///   - [`portal_arn(Option<String>)`](crate::operation::get_portal::GetPortalOutput::portal_arn): <p>The ARN of the portal.</p>
15    ///   - [`portal_content(Option<PortalContent>)`](crate::operation::get_portal::GetPortalOutput::portal_content): <p>Contains the content that is visible to portal consumers including the themes, display names, and description.</p>
16    ///   - [`portal_id(Option<String>)`](crate::operation::get_portal::GetPortalOutput::portal_id): <p>The portal identifier.</p>
17    ///   - [`preview(Option<Preview>)`](crate::operation::get_portal::GetPortalOutput::preview): <p>Represents the preview endpoint and the any possible error messages during preview generation.</p>
18    ///   - [`publish_status(Option<PublishStatus>)`](crate::operation::get_portal::GetPortalOutput::publish_status): <p>The publish status of a portal.</p>
19    ///   - [`rum_app_monitor_name(Option<String>)`](crate::operation::get_portal::GetPortalOutput::rum_app_monitor_name): <p>The CloudWatch RUM app monitor name.</p>
20    ///   - [`status_exception(Option<StatusException>)`](crate::operation::get_portal::GetPortalOutput::status_exception): <p>The status exception information.</p>
21    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_portal::GetPortalOutput::tags): <p>The collection of tags. Each tag element is associated with a given resource.</p>
22    /// - On failure, responds with [`SdkError<GetPortalError>`](crate::operation::get_portal::GetPortalError)
23    pub fn get_portal(&self) -> crate::operation::get_portal::builders::GetPortalFluentBuilder {
24        crate::operation::get_portal::builders::GetPortalFluentBuilder::new(self.handle.clone())
25    }
26}
aws_sdk_apigatewayv2/client/get_portal.rs

aws_sdk_apigatewayv2/client/
get_portal.rs
