AmazonApiGatewayV2

2026/03/25 - AmazonApiGatewayV2 - 4 updated api methods

Changes  Added DISABLE IN PROGRESS and DISABLE FAILED Portal statuses.

CreatePortal (updated) Link ¶
Changes (response)
{'PublishStatus': {'DISABLE_FAILED', 'DISABLE_IN_PROGRESS'}}

Creates a portal.

See also: AWS API Documentation

Request Syntax

client.create_portal(
    Authorization={
        'CognitoConfig': {
            'AppClientId': 'string',
            'UserPoolArn': 'string',
            'UserPoolDomain': 'string'
        },
        'None': {}

    },
    EndpointConfiguration={
        'AcmManaged': {
            'CertificateArn': 'string',
            'DomainName': 'string'
        },
        'None': {}

    },
    IncludedPortalProductArns=[
        'string',
    ],
    LogoUri='string',
    PortalContent={
        'Description': 'string',
        'DisplayName': 'string',
        'Theme': {
            'CustomColors': {
                'AccentColor': 'string',
                'BackgroundColor': 'string',
                'ErrorValidationColor': 'string',
                'HeaderColor': 'string',
                'NavigationColor': 'string',
                'TextColor': 'string'
            },
            'LogoLastUploaded': datetime(2015, 1, 1)
        }
    },
    RumAppMonitorName='string',
    Tags={
        'string': 'string'
    }
)
type Authorization:

dict

param Authorization:

[REQUIRED]

The authentication configuration for the portal.

  • CognitoConfig (dict) --

    The Amazon Cognito configuration.

    • AppClientId (string) -- [REQUIRED]

      The app client ID.

    • UserPoolArn (string) -- [REQUIRED]

      The user pool ARN.

    • UserPoolDomain (string) -- [REQUIRED]

      The user pool domain.

  • None (dict) --

    Provide no authorization for your portal. This makes your portal publicly accesible on the web.

type EndpointConfiguration:

dict

param EndpointConfiguration:

[REQUIRED]

The domain configuration for the portal. Use a default domain provided by API Gateway or provide a fully-qualified domain name that you own.

  • AcmManaged (dict) --

    Represents a domain name and certificate for a portal.

    • CertificateArn (string) -- [REQUIRED]

      The certificate ARN.

    • DomainName (string) -- [REQUIRED]

      The domain name.

  • None (dict) --

    Use the default portal domain name that is generated and managed by API Gateway.

type IncludedPortalProductArns:

list

param IncludedPortalProductArns:

The ARNs of the portal products included in the portal.

  • (string) --

type LogoUri:

string

param LogoUri:

The URI for the portal logo image that is displayed in the portal header.

type PortalContent:

dict

param PortalContent:

[REQUIRED]

The content of the portal.

  • Description (string) --

    A description of the portal.

  • DisplayName (string) -- [REQUIRED]

    The display name for the portal.

  • Theme (dict) -- [REQUIRED]

    The theme for the portal.

    • CustomColors (dict) -- [REQUIRED]

      Defines custom color values.

      • AccentColor (string) -- [REQUIRED]

        Represents the accent color.

      • BackgroundColor (string) -- [REQUIRED]

        Represents the background color.

      • ErrorValidationColor (string) -- [REQUIRED]

        The errorValidationColor.

      • HeaderColor (string) -- [REQUIRED]

        Represents the header color.

      • NavigationColor (string) -- [REQUIRED]

        Represents the navigation color.

      • TextColor (string) -- [REQUIRED]

        Represents the text color.

    • LogoLastUploaded (datetime) --

      The timestamp when the logo was last uploaded.

type RumAppMonitorName:

string

param RumAppMonitorName:

The name of the Amazon CloudWatch RUM app monitor for the portal.

type Tags:

dict

param Tags:

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

  • (string) --

    • (string) --

      A string with a length between [0-1600].

rtype:

dict

returns:

Response Syntax

{
    'Authorization': {
        'CognitoConfig': {
            'AppClientId': 'string',
            'UserPoolArn': 'string',
            'UserPoolDomain': 'string'
        },
        'None': {}
    },
    'EndpointConfiguration': {
        'CertificateArn': 'string',
        'DomainName': 'string',
        'PortalDefaultDomainName': 'string',
        'PortalDomainHostedZoneId': 'string'
    },
    'IncludedPortalProductArns': [
        'string',
    ],
    'LastModified': datetime(2015, 1, 1),
    'LastPublished': datetime(2015, 1, 1),
    'LastPublishedDescription': 'string',
    'PortalArn': 'string',
    'PortalContent': {
        'Description': 'string',
        'DisplayName': 'string',
        'Theme': {
            'CustomColors': {
                'AccentColor': 'string',
                'BackgroundColor': 'string',
                'ErrorValidationColor': 'string',
                'HeaderColor': 'string',
                'NavigationColor': 'string',
                'TextColor': 'string'
            },
            'LogoLastUploaded': datetime(2015, 1, 1)
        }
    },
    'PortalId': 'string',
    'PublishStatus': 'PUBLISHED'|'PUBLISH_IN_PROGRESS'|'PUBLISH_FAILED'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED'|'DISABLED',
    'RumAppMonitorName': 'string',
    'StatusException': {
        'Exception': 'string',
        'Message': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • Authorization (dict) --

      The authorization for the portal. Supports Cognito-based user authentication or no authentication.

      • CognitoConfig (dict) --

        The Amazon Cognito configuration.

        • AppClientId (string) --

          The app client ID.

        • UserPoolArn (string) --

          The user pool ARN.

        • UserPoolDomain (string) --

          The user pool domain.

      • None (dict) --

        Provide no authorization for your portal. This makes your portal publicly accesible on the web.

    • EndpointConfiguration (dict) --

      The endpoint configuration.

      • CertificateArn (string) --

        The ARN of the ACM certificate.

      • DomainName (string) --

        The domain name.

      • PortalDefaultDomainName (string) --

        The portal default domain name. This domain name is generated and managed by API Gateway.

      • PortalDomainHostedZoneId (string) --

        The portal domain hosted zone identifier.

    • IncludedPortalProductArns (list) --

      The ARNs of the portal products included in the portal.

      • (string) --

    • LastModified (datetime) --

      The timestamp when the portal configuration was last modified.

    • LastPublished (datetime) --

      The timestamp when the portal was last published.

    • LastPublishedDescription (string) --

      A user-written description of the changes made in the last published version of the portal.

    • PortalArn (string) --

      The ARN of the portal.

    • PortalContent (dict) --

      The name, description, and theme for the portal.

      • Description (string) --

        A description of the portal.

      • DisplayName (string) --

        The display name for the portal.

      • Theme (dict) --

        The theme for the portal.

        • CustomColors (dict) --

          Defines custom color values.

          • AccentColor (string) --

            Represents the accent color.

          • BackgroundColor (string) --

            Represents the background color.

          • ErrorValidationColor (string) --

            The errorValidationColor.

          • HeaderColor (string) --

            Represents the header color.

          • NavigationColor (string) --

            Represents the navigation color.

          • TextColor (string) --

            Represents the text color.

        • LogoLastUploaded (datetime) --

          The timestamp when the logo was last uploaded.

    • PortalId (string) --

      The portal identifier.

    • PublishStatus (string) --

      The current publishing status of the portal.

    • RumAppMonitorName (string) --

      The name of the Amazon CloudWatch RUM app monitor.

    • StatusException (dict) --

      Error information for failed portal operations. Contains details about any issues encountered during portal creation or publishing.

      • Exception (string) --

        The exception.

      • Message (string) --

        The error message.

    • Tags (dict) --

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

      • (string) --

        • (string) --

          A string with a length between [0-1600].

GetPortal (updated) Link ¶
Changes (response)
{'PublishStatus': {'DISABLE_FAILED', 'DISABLE_IN_PROGRESS'}}

Gets a portal.

See also: AWS API Documentation

Request Syntax

client.get_portal(
    PortalId='string'
)
type PortalId:

string

param PortalId:

[REQUIRED]

The portal identifier.

rtype:

dict

returns:

Response Syntax

{
    'Authorization': {
        'CognitoConfig': {
            'AppClientId': 'string',
            'UserPoolArn': 'string',
            'UserPoolDomain': 'string'
        },
        'None': {}
    },
    'EndpointConfiguration': {
        'CertificateArn': 'string',
        'DomainName': 'string',
        'PortalDefaultDomainName': 'string',
        'PortalDomainHostedZoneId': 'string'
    },
    'IncludedPortalProductArns': [
        'string',
    ],
    'LastModified': datetime(2015, 1, 1),
    'LastPublished': datetime(2015, 1, 1),
    'LastPublishedDescription': 'string',
    'PortalArn': 'string',
    'PortalContent': {
        'Description': 'string',
        'DisplayName': 'string',
        'Theme': {
            'CustomColors': {
                'AccentColor': 'string',
                'BackgroundColor': 'string',
                'ErrorValidationColor': 'string',
                'HeaderColor': 'string',
                'NavigationColor': 'string',
                'TextColor': 'string'
            },
            'LogoLastUploaded': datetime(2015, 1, 1)
        }
    },
    'PortalId': 'string',
    'Preview': {
        'PreviewStatus': 'PREVIEW_IN_PROGRESS'|'PREVIEW_FAILED'|'PREVIEW_READY',
        'PreviewUrl': 'string',
        'StatusException': {
            'Exception': 'string',
            'Message': 'string'
        }
    },
    'PublishStatus': 'PUBLISHED'|'PUBLISH_IN_PROGRESS'|'PUBLISH_FAILED'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED'|'DISABLED',
    'RumAppMonitorName': 'string',
    'StatusException': {
        'Exception': 'string',
        'Message': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • Authorization (dict) --

      The authorization for the portal.

      • CognitoConfig (dict) --

        The Amazon Cognito configuration.

        • AppClientId (string) --

          The app client ID.

        • UserPoolArn (string) --

          The user pool ARN.

        • UserPoolDomain (string) --

          The user pool domain.

      • None (dict) --

        Provide no authorization for your portal. This makes your portal publicly accesible on the web.

    • EndpointConfiguration (dict) --

      The endpoint configuration.

      • CertificateArn (string) --

        The ARN of the ACM certificate.

      • DomainName (string) --

        The domain name.

      • PortalDefaultDomainName (string) --

        The portal default domain name. This domain name is generated and managed by API Gateway.

      • PortalDomainHostedZoneId (string) --

        The portal domain hosted zone identifier.

    • IncludedPortalProductArns (list) --

      The ARNs of the portal products included in the portal.

      • (string) --

    • LastModified (datetime) --

      The timestamp when the portal was last modified.

    • LastPublished (datetime) --

      The timestamp when the portal was last published.

    • LastPublishedDescription (string) --

      The publish description used when the portal was last published.

    • PortalArn (string) --

      The ARN of the portal.

    • PortalContent (dict) --

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

      • Description (string) --

        A description of the portal.

      • DisplayName (string) --

        The display name for the portal.

      • Theme (dict) --

        The theme for the portal.

        • CustomColors (dict) --

          Defines custom color values.

          • AccentColor (string) --

            Represents the accent color.

          • BackgroundColor (string) --

            Represents the background color.

          • ErrorValidationColor (string) --

            The errorValidationColor.

          • HeaderColor (string) --

            Represents the header color.

          • NavigationColor (string) --

            Represents the navigation color.

          • TextColor (string) --

            Represents the text color.

        • LogoLastUploaded (datetime) --

          The timestamp when the logo was last uploaded.

    • PortalId (string) --

      The portal identifier.

    • Preview (dict) --

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

      • PreviewStatus (string) --

        The status of the preview.

      • PreviewUrl (string) --

        The URL of the preview.

      • StatusException (dict) --

        The status exception information.

        • Exception (string) --

          The exception.

        • Message (string) --

          The error message.

    • PublishStatus (string) --

      The publish status of a portal.

    • RumAppMonitorName (string) --

      The CloudWatch RUM app monitor name.

    • StatusException (dict) --

      The status exception information.

      • Exception (string) --

        The exception.

      • Message (string) --

        The error message.

    • Tags (dict) --

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

      • (string) --

        • (string) --

          A string with a length between [0-1600].

ListPortals (updated) Link ¶
Changes (response)
{'Items': {'PublishStatus': {'DISABLE_FAILED', 'DISABLE_IN_PROGRESS'}}}

Lists portals.

See also: AWS API Documentation

Request Syntax

client.list_portals(
    MaxResults='string',
    NextToken='string'
)
type MaxResults:

string

param MaxResults:

The maximum number of elements to be returned for this resource.

type NextToken:

string

param NextToken:

The next page of elements from this collection. Not valid for the last element of the collection.

rtype:

dict

returns:

Response Syntax

{
    'Items': [
        {
            'Authorization': {
                'CognitoConfig': {
                    'AppClientId': 'string',
                    'UserPoolArn': 'string',
                    'UserPoolDomain': 'string'
                },
                'None': {}
            },
            'EndpointConfiguration': {
                'CertificateArn': 'string',
                'DomainName': 'string',
                'PortalDefaultDomainName': 'string',
                'PortalDomainHostedZoneId': 'string'
            },
            'IncludedPortalProductArns': [
                'string',
            ],
            'LastModified': datetime(2015, 1, 1),
            'LastPublished': datetime(2015, 1, 1),
            'LastPublishedDescription': 'string',
            'PortalArn': 'string',
            'PortalContent': {
                'Description': 'string',
                'DisplayName': 'string',
                'Theme': {
                    'CustomColors': {
                        'AccentColor': 'string',
                        'BackgroundColor': 'string',
                        'ErrorValidationColor': 'string',
                        'HeaderColor': 'string',
                        'NavigationColor': 'string',
                        'TextColor': 'string'
                    },
                    'LogoLastUploaded': datetime(2015, 1, 1)
                }
            },
            'PortalId': 'string',
            'Preview': {
                'PreviewStatus': 'PREVIEW_IN_PROGRESS'|'PREVIEW_FAILED'|'PREVIEW_READY',
                'PreviewUrl': 'string',
                'StatusException': {
                    'Exception': 'string',
                    'Message': 'string'
                }
            },
            'PublishStatus': 'PUBLISHED'|'PUBLISH_IN_PROGRESS'|'PUBLISH_FAILED'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED'|'DISABLED',
            'RumAppMonitorName': 'string',
            'StatusException': {
                'Exception': 'string',
                'Message': 'string'
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents a portal summary.

        • Authorization (dict) --

          The authorization of the portal.

          • CognitoConfig (dict) --

            The Amazon Cognito configuration.

            • AppClientId (string) --

              The app client ID.

            • UserPoolArn (string) --

              The user pool ARN.

            • UserPoolDomain (string) --

              The user pool domain.

          • None (dict) --

            Provide no authorization for your portal. This makes your portal publicly accesible on the web.

        • EndpointConfiguration (dict) --

          The endpoint configuration of the portal.

          • CertificateArn (string) --

            The ARN of the ACM certificate.

          • DomainName (string) --

            The domain name.

          • PortalDefaultDomainName (string) --

            The portal default domain name. This domain name is generated and managed by API Gateway.

          • PortalDomainHostedZoneId (string) --

            The portal domain hosted zone identifier.

        • IncludedPortalProductArns (list) --

          The ARNs of the portal products included in the portal.

          • (string) --

        • LastModified (datetime) --

          The timestamp when the portal was last modified.

        • LastPublished (datetime) --

          The timestamp when the portal was last published.

        • LastPublishedDescription (string) --

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

        • PortalArn (string) --

          The ARN of the portal.

        • PortalContent (dict) --

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

          • Description (string) --

            A description of the portal.

          • DisplayName (string) --

            The display name for the portal.

          • Theme (dict) --

            The theme for the portal.

            • CustomColors (dict) --

              Defines custom color values.

              • AccentColor (string) --

                Represents the accent color.

              • BackgroundColor (string) --

                Represents the background color.

              • ErrorValidationColor (string) --

                The errorValidationColor.

              • HeaderColor (string) --

                Represents the header color.

              • NavigationColor (string) --

                Represents the navigation color.

              • TextColor (string) --

                Represents the text color.

            • LogoLastUploaded (datetime) --

              The timestamp when the logo was last uploaded.

        • PortalId (string) --

          The portal identifier.

        • Preview (dict) --

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

          • PreviewStatus (string) --

            The status of the preview.

          • PreviewUrl (string) --

            The URL of the preview.

          • StatusException (dict) --

            The status exception information.

            • Exception (string) --

              The exception.

            • Message (string) --

              The error message.

        • PublishStatus (string) --

          The publish status.

        • RumAppMonitorName (string) --

          The CloudWatch RUM app monitor name.

        • StatusException (dict) --

          The status exception information.

          • Exception (string) --

            The exception.

          • Message (string) --

            The error message.

        • Tags (dict) --

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

          • (string) --

            • (string) --

              A string with a length between [0-1600].

    • NextToken (string) --

      The next page of elements from this collection. Not valid for the last element of the collection.

UpdatePortal (updated) Link ¶
Changes (response)
{'PublishStatus': {'DISABLE_FAILED', 'DISABLE_IN_PROGRESS'}}

Updates a portal.

See also: AWS API Documentation

Request Syntax

client.update_portal(
    Authorization={
        'CognitoConfig': {
            'AppClientId': 'string',
            'UserPoolArn': 'string',
            'UserPoolDomain': 'string'
        },
        'None': {}

    },
    EndpointConfiguration={
        'AcmManaged': {
            'CertificateArn': 'string',
            'DomainName': 'string'
        },
        'None': {}

    },
    IncludedPortalProductArns=[
        'string',
    ],
    LogoUri='string',
    PortalContent={
        'Description': 'string',
        'DisplayName': 'string',
        'Theme': {
            'CustomColors': {
                'AccentColor': 'string',
                'BackgroundColor': 'string',
                'ErrorValidationColor': 'string',
                'HeaderColor': 'string',
                'NavigationColor': 'string',
                'TextColor': 'string'
            },
            'LogoLastUploaded': datetime(2015, 1, 1)
        }
    },
    PortalId='string',
    RumAppMonitorName='string'
)
type Authorization:

dict

param Authorization:

The authorization of the portal.

  • CognitoConfig (dict) --

    The Amazon Cognito configuration.

    • AppClientId (string) -- [REQUIRED]

      The app client ID.

    • UserPoolArn (string) -- [REQUIRED]

      The user pool ARN.

    • UserPoolDomain (string) -- [REQUIRED]

      The user pool domain.

  • None (dict) --

    Provide no authorization for your portal. This makes your portal publicly accesible on the web.

type EndpointConfiguration:

dict

param EndpointConfiguration:

Represents an endpoint configuration.

  • AcmManaged (dict) --

    Represents a domain name and certificate for a portal.

    • CertificateArn (string) -- [REQUIRED]

      The certificate ARN.

    • DomainName (string) -- [REQUIRED]

      The domain name.

  • None (dict) --

    Use the default portal domain name that is generated and managed by API Gateway.

type IncludedPortalProductArns:

list

param IncludedPortalProductArns:

The ARNs of the portal products included in the portal.

  • (string) --

type LogoUri:

string

param LogoUri:

The logo URI.

type PortalContent:

dict

param PortalContent:

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

  • Description (string) --

    A description of the portal.

  • DisplayName (string) -- [REQUIRED]

    The display name for the portal.

  • Theme (dict) -- [REQUIRED]

    The theme for the portal.

    • CustomColors (dict) -- [REQUIRED]

      Defines custom color values.

      • AccentColor (string) -- [REQUIRED]

        Represents the accent color.

      • BackgroundColor (string) -- [REQUIRED]

        Represents the background color.

      • ErrorValidationColor (string) -- [REQUIRED]

        The errorValidationColor.

      • HeaderColor (string) -- [REQUIRED]

        Represents the header color.

      • NavigationColor (string) -- [REQUIRED]

        Represents the navigation color.

      • TextColor (string) -- [REQUIRED]

        Represents the text color.

    • LogoLastUploaded (datetime) --

      The timestamp when the logo was last uploaded.

type PortalId:

string

param PortalId:

[REQUIRED]

The portal identifier.

type RumAppMonitorName:

string

param RumAppMonitorName:

The CloudWatch RUM app monitor name.

rtype:

dict

returns:

Response Syntax

{
    'Authorization': {
        'CognitoConfig': {
            'AppClientId': 'string',
            'UserPoolArn': 'string',
            'UserPoolDomain': 'string'
        },
        'None': {}
    },
    'EndpointConfiguration': {
        'CertificateArn': 'string',
        'DomainName': 'string',
        'PortalDefaultDomainName': 'string',
        'PortalDomainHostedZoneId': 'string'
    },
    'IncludedPortalProductArns': [
        'string',
    ],
    'LastModified': datetime(2015, 1, 1),
    'LastPublished': datetime(2015, 1, 1),
    'LastPublishedDescription': 'string',
    'PortalArn': 'string',
    'PortalContent': {
        'Description': 'string',
        'DisplayName': 'string',
        'Theme': {
            'CustomColors': {
                'AccentColor': 'string',
                'BackgroundColor': 'string',
                'ErrorValidationColor': 'string',
                'HeaderColor': 'string',
                'NavigationColor': 'string',
                'TextColor': 'string'
            },
            'LogoLastUploaded': datetime(2015, 1, 1)
        }
    },
    'PortalId': 'string',
    'Preview': {
        'PreviewStatus': 'PREVIEW_IN_PROGRESS'|'PREVIEW_FAILED'|'PREVIEW_READY',
        'PreviewUrl': 'string',
        'StatusException': {
            'Exception': 'string',
            'Message': 'string'
        }
    },
    'PublishStatus': 'PUBLISHED'|'PUBLISH_IN_PROGRESS'|'PUBLISH_FAILED'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED'|'DISABLED',
    'RumAppMonitorName': 'string',
    'StatusException': {
        'Exception': 'string',
        'Message': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    200 response

    • Authorization (dict) --

      The authorization for the portal.

      • CognitoConfig (dict) --

        The Amazon Cognito configuration.

        • AppClientId (string) --

          The app client ID.

        • UserPoolArn (string) --

          The user pool ARN.

        • UserPoolDomain (string) --

          The user pool domain.

      • None (dict) --

        Provide no authorization for your portal. This makes your portal publicly accesible on the web.

    • EndpointConfiguration (dict) --

      The endpoint configuration.

      • CertificateArn (string) --

        The ARN of the ACM certificate.

      • DomainName (string) --

        The domain name.

      • PortalDefaultDomainName (string) --

        The portal default domain name. This domain name is generated and managed by API Gateway.

      • PortalDomainHostedZoneId (string) --

        The portal domain hosted zone identifier.

    • IncludedPortalProductArns (list) --

      The ARNs of the portal products included in the portal.

      • (string) --

    • LastModified (datetime) --

      The timestamp when the portal was last modified.

    • LastPublished (datetime) --

      The timestamp when the portal was last published.

    • LastPublishedDescription (string) --

      The description associated with the last time the portal was published.

    • PortalArn (string) --

      The ARN of the portal.

    • PortalContent (dict) --

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

      • Description (string) --

        A description of the portal.

      • DisplayName (string) --

        The display name for the portal.

      • Theme (dict) --

        The theme for the portal.

        • CustomColors (dict) --

          Defines custom color values.

          • AccentColor (string) --

            Represents the accent color.

          • BackgroundColor (string) --

            Represents the background color.

          • ErrorValidationColor (string) --

            The errorValidationColor.

          • HeaderColor (string) --

            Represents the header color.

          • NavigationColor (string) --

            Represents the navigation color.

          • TextColor (string) --

            Represents the text color.

        • LogoLastUploaded (datetime) --

          The timestamp when the logo was last uploaded.

    • PortalId (string) --

      The portal identifier.

    • Preview (dict) --

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

      • PreviewStatus (string) --

        The status of the preview.

      • PreviewUrl (string) --

        The URL of the preview.

      • StatusException (dict) --

        The status exception information.

        • Exception (string) --

          The exception.

        • Message (string) --

          The error message.

    • PublishStatus (string) --

      The publishStatus.

    • RumAppMonitorName (string) --

      The CloudWatch RUM app monitor name.

    • StatusException (dict) --

      The status exception information.

      • Exception (string) --

        The exception.

      • Message (string) --

        The error message.

    • Tags (dict) --

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

      • (string) --

        • (string) --

          A string with a length between [0-1600].