ApiGatewayV2 / Client / create_portal

create_portal¶

ApiGatewayV2.Client.create_portal(**kwargs)¶

Creates a portal.

Request Syntax

response = 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'
    }
)

Parameters:

Authorization (dict) –
[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.
EndpointConfiguration (dict) –
[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.
IncludedPortalProductArns (list) –
The ARNs of the portal products included in the portal.
- (string) –
LogoUri (string) – The URI for the portal logo image that is displayed in the portal header.
PortalContent (dict) –
[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.
RumAppMonitorName (string) – The name of the Amazon CloudWatch RUM app monitor for the portal.
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].

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',
    'PublishStatus': 'PUBLISHED'|'PUBLISH_IN_PROGRESS'|'PUBLISH_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].

create_portal¶

Request Syntax

Response Syntax

Response Structure

Exceptions