ApiGatewayV2 / Client / get_portal

get_portal¶

ApiGatewayV2.Client.get_portal(**kwargs)¶

Gets a portal.

Request Syntax

response = client.get_portal(
    PortalId='string'
)

Parameters:

PortalId (string) –

[REQUIRED]

The portal identifier.

Return type:

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'|'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].

get_portal¶

Request Syntax

Response Syntax

Response Structure

Exceptions