Class: Aws::ApiGatewayV2::Types::PortalSummary

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::PortalSummary

Includes:

Structure

Defined in:

lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents a portal summary.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authorization ⇒ Types::Authorization

  The authorization of the portal.

• #endpoint_configuration ⇒ Types::EndpointConfigurationResponse

  The endpoint configuration of the portal.

• #included_portal_product_arns ⇒ Array<String>

  The ARNs of the portal products included in the portal.

• #last_modified ⇒ Time

  The timestamp when the portal was last modified.

• #last_published ⇒ Time

  The timestamp when the portal was last published.

• #last_published_description ⇒ String

  The description of the portal the last time it was published.

• #portal_arn ⇒ String

  The ARN of the portal.

• #portal_content ⇒ Types::PortalContent

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

• #portal_id ⇒ String

  The portal identifier.

• #preview ⇒ Types::Preview

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

• #publish_status ⇒ String

  The publish status.

• #rum_app_monitor_name ⇒ String

  The CloudWatch RUM app monitor name.

• #status_exception ⇒ Types::StatusException

  The status exception information.

• #tags ⇒ Hash<String,String>

  The collection of tags.

Instance Attribute Details

#authorization ⇒ Types::Authorization

The authorization of the portal.

Returns:

• (Types::Authorization)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_configuration ⇒ Types::EndpointConfigurationResponse

The endpoint configuration of the portal.

Returns:

• (Types::EndpointConfigurationResponse)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#included_portal_product_arns ⇒ Array<String>

The ARNs of the portal products included in the portal.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified ⇒ Time

The timestamp when the portal was last modified.

Returns:

• (Time)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_published ⇒ Time

The timestamp when the portal was last published.

Returns:

• (Time)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_published_description ⇒ String

The description of the portal the last time it was published.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#portal_arn ⇒ String

The ARN of the portal.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#portal_content ⇒ Types::PortalContent

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

Returns:

• (Types::PortalContent)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#portal_id ⇒ String

The portal identifier.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#preview ⇒ Types::Preview

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

Returns:

• (Types::Preview)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#publish_status ⇒ String

The publish status.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rum_app_monitor_name ⇒ String

The CloudWatch RUM app monitor name.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status_exception ⇒ Types::StatusException

The status exception information.

Returns:

• (Types::StatusException)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 7241

class PortalSummary < Struct.new(
  :authorization,
  :endpoint_configuration,
  :included_portal_product_arns,
  :last_modified,
  :last_published,
  :last_published_description,
  :portal_arn,
  :portal_content,
  :portal_id,
  :preview,
  :publish_status,
  :rum_app_monitor_name,
  :status_exception,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end