AWS API Changes

2025/11/19 - AmazonApiGatewayV2 - 26 new api methods

Changes Support for API Gateway portals and portal products.

DeletePortalProduct (new)

Deletes a portal product.

Request Syntax

client.delete_portal_product(
    PortalProductId='string'
)

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

returns:

None

ListPortalProducts (new)

Link ¶

Lists portal products.

See also: AWS API Documentation

Request Syntax

client.list_portal_products(
    MaxResults='string',
    NextToken='string',
    ResourceOwner='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.

type ResourceOwner:

string

param ResourceOwner:

The resource owner of the portal product.

rtype:

dict

returns:

Response Syntax

{
    'Items': [
        {
            'Description': 'string',
            'DisplayName': 'string',
            'LastModified': datetime(2015, 1, 1),
            'PortalProductArn': 'string',
            'PortalProductId': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Success
- Items (list) --
  
  The elements from this collection.
  - (dict) --
    
    Represents a portal product.
    - Description (string) --
      
      The description.
    - DisplayName (string) --
      
      The display name of a portal product.
    - LastModified (datetime) --
      
      The timestamp when the portal product was last modified.
    - PortalProductArn (string) --
      
      The ARN of a portal product.
    - PortalProductId (string) --
      
      The portal product identifier.
    - 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.

DeletePortalProductSharingPolicy (new)

Link ¶

Deletes the sharing policy for a portal product.

See also: AWS API Documentation

Request Syntax

client.delete_portal_product_sharing_policy(
    PortalProductId='string'
)

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

returns:

None

DeleteProductRestEndpointPage (new)

Link ¶

Deletes a product REST endpoint page.

See also: AWS API Documentation

Request Syntax

client.delete_product_rest_endpoint_page(
    PortalProductId='string',
    ProductRestEndpointPageId='string'
)

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type ProductRestEndpointPageId:

string

param ProductRestEndpointPageId:

[REQUIRED]

The product REST endpoint identifier.

returns:

None

GetPortal (new)

Link ¶

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

CreatePortal (new)

Link ¶

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

GetPortalProduct (new)

Link ¶

Gets a portal product.

See also: AWS API Documentation

Request Syntax

client.get_portal_product(
    PortalProductId='string',
    ResourceOwnerAccountId='string'
)

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type ResourceOwnerAccountId:

string

param ResourceOwnerAccountId:

The account ID of the resource owner of the portal product.

rtype:

dict

returns:

Response Syntax

{
    'Description': 'string',
    'DisplayName': 'string',
    'DisplayOrder': {
        'Contents': [
            {
                'ProductRestEndpointPageArns': [
                    'string',
                ],
                'SectionName': 'string'
            },
        ],
        'OverviewPageArn': 'string',
        'ProductPageArns': [
            'string',
        ]
    },
    'LastModified': datetime(2015, 1, 1),
    'PortalProductArn': 'string',
    'PortalProductId': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --

Success
- Description (string) --
  
  The description of a portal product.
- DisplayName (string) --
  
  The display name.
- DisplayOrder (dict) --
  
  The display order.
  - Contents (list) --
    
    Represents a list of sections which include section name and list of product REST endpoints for a product.
    - (dict) --
      
      Contains the section name and list of product REST endpoints for a product.
      - ProductRestEndpointPageArns (list) --
        
        The ARNs of the product REST endpoint pages in a portal product.
        
        (string) --
      - SectionName (string) --
        
        The section name.
  - OverviewPageArn (string) --
    
    The ARN of the overview page.
  - ProductPageArns (list) --
    
    The product page ARNs.
    - (string) --
- LastModified (datetime) --
  
  The timestamp when the portal product was last modified.
- PortalProductArn (string) --
  
  The ARN of the portal product.
- PortalProductId (string) --
  
  The portal product identifier.
- 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].

UpdateProductPage (new)

Link ¶

Updates a product page of a portal product.

See also: AWS API Documentation

Request Syntax

client.update_product_page(
    DisplayContent={
        'Body': 'string',
        'Title': 'string'
    },
    PortalProductId='string',
    ProductPageId='string'
)

type DisplayContent:

dict

param DisplayContent:

The content of the product page.

Body (string) -- [REQUIRED]

The body.
Title (string) -- [REQUIRED]

The title.

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type ProductPageId:

string

param ProductPageId:

[REQUIRED]

The portal product identifier.

rtype:

dict

returns:

Response Syntax

{
    'DisplayContent': {
        'Body': 'string',
        'Title': 'string'
    },
    'LastModified': datetime(2015, 1, 1),
    'ProductPageArn': 'string',
    'ProductPageId': 'string'
}

Response Structure

(dict) --

200 response
- DisplayContent (dict) --
  
  The content of the product page.
  - Body (string) --
    
    The body.
  - Title (string) --
    
    The title.
- LastModified (datetime) --
  
  The timestamp when the product page was last modified.
- ProductPageArn (string) --
  
  The ARN of the product page.
- ProductPageId (string) --
  
  The product page identifier.

GetProductPage (new)

Link ¶

Gets a product page of a portal product.

See also: AWS API Documentation

Request Syntax

client.get_product_page(
    PortalProductId='string',
    ProductPageId='string',
    ResourceOwnerAccountId='string'
)

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type ProductPageId:

string

param ProductPageId:

[REQUIRED]

The portal product identifier.

type ResourceOwnerAccountId:

string

param ResourceOwnerAccountId:

The account ID of the resource owner of the portal product.

rtype:

dict

returns:

Response Syntax

{
    'DisplayContent': {
        'Body': 'string',
        'Title': 'string'
    },
    'LastModified': datetime(2015, 1, 1),
    'ProductPageArn': 'string',
    'ProductPageId': 'string'
}

Response Structure

(dict) --

Success
- DisplayContent (dict) --
  
  The content of the product page.
  - Body (string) --
    
    The body.
  - Title (string) --
    
    The title.
- LastModified (datetime) --
  
  The timestamp when the product page was last modified.
- ProductPageArn (string) --
  
  The ARN of the product page.
- ProductPageId (string) --
  
  The product page identifier.

PreviewPortal (new)

Link ¶

Creates a portal preview.

See also: AWS API Documentation

Request Syntax

client.preview_portal(
    PortalId='string'
)

type PortalId:

string

param PortalId:

[REQUIRED]

The portal identifier.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

202 response

ListProductPages (new)

Link ¶

Lists the product pages for a portal product.

See also: AWS API Documentation

Request Syntax

client.list_product_pages(
    MaxResults='string',
    NextToken='string',
    PortalProductId='string',
    ResourceOwnerAccountId='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.

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type ResourceOwnerAccountId:

string

param ResourceOwnerAccountId:

The account ID of the resource owner of the portal product.

rtype:

dict

returns:

Response Syntax

{
    'Items': [
        {
            'LastModified': datetime(2015, 1, 1),
            'PageTitle': 'string',
            'ProductPageArn': 'string',
            'ProductPageId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Success
- Items (list) --
  
  The elements from this collection.
  - (dict) --
    
    Represents a product page summary without listing any page content.
    - LastModified (datetime) --
      
      The timestamp when the product page was last modified.
    - PageTitle (string) --
      
      The page title.
    - ProductPageArn (string) --
      
      The ARN of the product page.
    - ProductPageId (string) --
      
      The product page identifier.
- NextToken (string) --
  
  The next page of elements from this collection. Not valid for the last element of the collection.

DeletePortal (new)

Link ¶

Deletes a portal.

See also: AWS API Documentation

Request Syntax

client.delete_portal(
    PortalId='string'
)

type PortalId:

string

param PortalId:

[REQUIRED]

The portal identifier.

returns:

None

PutPortalProductSharingPolicy (new)

Link ¶

Updates the sharing policy for a portal product.

See also: AWS API Documentation

Request Syntax

client.put_portal_product_sharing_policy(
    PolicyDocument='string',
    PortalProductId='string'
)

type PolicyDocument:

string

param PolicyDocument:

[REQUIRED]

The product sharing policy.

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

200 response

PublishPortal (new)

Link ¶

Publishes a portal.

See also: AWS API Documentation

Request Syntax

client.publish_portal(
    Description='string',
    PortalId='string'
)

type Description:

string

param Description:

The description of the portal. When the portal is published, this description becomes the last published description.

type PortalId:

string

param PortalId:

[REQUIRED]

The portal identifier.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

202 response

DeleteProductPage (new)

Link ¶

Deletes a product page of a portal product.

See also: AWS API Documentation

Request Syntax

client.delete_product_page(
    PortalProductId='string',
    ProductPageId='string'
)

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type ProductPageId:

string

param ProductPageId:

[REQUIRED]

The portal product identifier.

returns:

None

GetPortalProductSharingPolicy (new)

Link ¶

Gets the sharing policy for a portal product.

See also: AWS API Documentation

Request Syntax

client.get_portal_product_sharing_policy(
    PortalProductId='string'
)

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

rtype:

dict

returns:

Response Syntax

{
    'PolicyDocument': 'string',
    'PortalProductId': 'string'
}

Response Structure

(dict) --

Success
- PolicyDocument (string) --
  
  The product sharing policy.
- PortalProductId (string) --
  
  The portal product identifier.

CreatePortalProduct (new)

Link ¶

Creates a new portal product.

See also: AWS API Documentation

Request Syntax

client.create_portal_product(
    Description='string',
    DisplayName='string',
    Tags={
        'string': 'string'
    }
)

type Description:

string

param Description:

A description of the portal product.

type DisplayName:

string

param DisplayName:

[REQUIRED]

The name of the portal product as it appears in a published 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

{
    'Description': 'string',
    'DisplayName': 'string',
    'DisplayOrder': {
        'Contents': [
            {
                'ProductRestEndpointPageArns': [
                    'string',
                ],
                'SectionName': 'string'
            },
        ],
        'OverviewPageArn': 'string',
        'ProductPageArns': [
            'string',
        ]
    },
    'LastModified': datetime(2015, 1, 1),
    'PortalProductArn': 'string',
    'PortalProductId': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --

The request has succeeded and has resulted in the creation of a resource.
- Description (string) --
  
  A description of the portal product.
- DisplayName (string) --
  
  The display name for the portal product.
- DisplayOrder (dict) --
  
  The visual ordering of the product pages and product REST endpoint pages in a published portal.
  - Contents (list) --
    
    Represents a list of sections which include section name and list of product REST endpoints for a product.
    - (dict) --
      
      Contains the section name and list of product REST endpoints for a product.
      - ProductRestEndpointPageArns (list) --
        
        The ARNs of the product REST endpoint pages in a portal product.
        
        (string) --
      - SectionName (string) --
        
        The section name.
  - OverviewPageArn (string) --
    
    The ARN of the overview page.
  - ProductPageArns (list) --
    
    The product page ARNs.
    - (string) --
- LastModified (datetime) --
  
  The timestamp when the portal product was last modified.
- PortalProductArn (string) --
  
  The ARN of the portal product.
- PortalProductId (string) --
  
  The portal product identifier.
- 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].

UpdateProductRestEndpointPage (new)

Link ¶

Updates a product REST endpoint page.

See also: AWS API Documentation

Request Syntax

client.update_product_rest_endpoint_page(
    DisplayContent={
        'None': {}
        ,
        'Overrides': {
            'Body': 'string',
            'Endpoint': 'string',
            'OperationName': 'string'
        }
    },
    PortalProductId='string',
    ProductRestEndpointPageId='string',
    TryItState='ENABLED'|'DISABLED'
)

type DisplayContent:

dict

param DisplayContent:

The display content.

None (dict) --

If your product REST endpoint contains no overrides, the none object is returned.
Overrides (dict) --

The overrides for endpoint display content.
- Body (string) --
  
  By default, this is the documentation of your REST API from API Gateway. You can provide custom documentation to override this value.
- Endpoint (string) --
  
  The URL for your REST API. By default, API Gateway uses the default execute API endpoint. You can provide a custom domain to override this value.
- OperationName (string) --
  
  The operation name of the product REST endpoint.

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type ProductRestEndpointPageId:

string

param ProductRestEndpointPageId:

[REQUIRED]

The product REST endpoint identifier.

type TryItState:

string

param TryItState:

The try it state of a product REST endpoint page.

rtype:

dict

returns:

Response Syntax

{
    'DisplayContent': {
        'Body': 'string',
        'Endpoint': 'string',
        'OperationName': 'string'
    },
    'LastModified': datetime(2015, 1, 1),
    'ProductRestEndpointPageArn': 'string',
    'ProductRestEndpointPageId': 'string',
    'RestEndpointIdentifier': {
        'IdentifierParts': {
            'Method': 'string',
            'Path': 'string',
            'RestApiId': 'string',
            'Stage': 'string'
        }
    },
    'Status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
    'StatusException': {
        'Exception': 'string',
        'Message': 'string'
    },
    'TryItState': 'ENABLED'|'DISABLED'
}

Response Structure

(dict) --

200 response
- DisplayContent (dict) --
  
  The content of the product REST endpoint page.
  - Body (string) --
    
    The API documentation.
  - Endpoint (string) --
    
    The URL to invoke your REST API.
  - OperationName (string) --
    
    The operation name.
- LastModified (datetime) --
  
  The timestamp when the product REST endpoint page was last modified.
- ProductRestEndpointPageArn (string) --
  
  The ARN of the product REST endpoint page.
- ProductRestEndpointPageId (string) --
  
  The product REST endpoint page identifier.
- RestEndpointIdentifier (dict) --
  
  The REST endpoint identifier.
  - IdentifierParts (dict) --
    
    The identifier parts of the REST endpoint identifier.
    - Method (string) --
      
      The method of the product REST endpoint.
    - Path (string) --
      
      The path of the product REST endpoint.
    - RestApiId (string) --
      
      The REST API ID of the product REST endpoint.
    - Stage (string) --
      
      The stage of the product REST endpoint.
- Status (string) --
  
  The status.
- StatusException (dict) --
  
  The status exception information.
  - Exception (string) --
    
    The exception.
  - Message (string) --
    
    The error message.
- TryItState (string) --
  
  The try it state of a product REST endpoint page.

DisablePortal (new)

Link ¶

Deletes the publication of a portal portal.

See also: AWS API Documentation

Request Syntax

client.disable_portal(
    PortalId='string'
)

type PortalId:

string

param PortalId:

[REQUIRED]

The portal identifier.

returns:

None

UpdatePortal (new)

Link ¶

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

ListPortals (new)

Link ¶

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

ListProductRestEndpointPages (new)

Link ¶

Lists the product REST endpoint pages of a portal product.

See also: AWS API Documentation

Request Syntax

client.list_product_rest_endpoint_pages(
    MaxResults='string',
    NextToken='string',
    PortalProductId='string',
    ResourceOwnerAccountId='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.

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type ResourceOwnerAccountId:

string

param ResourceOwnerAccountId:

The account ID of the resource owner of the portal product.

rtype:

dict

returns:

Response Syntax

{
    'Items': [
        {
            'Endpoint': 'string',
            'LastModified': datetime(2015, 1, 1),
            'OperationName': 'string',
            'ProductRestEndpointPageArn': 'string',
            'ProductRestEndpointPageId': 'string',
            'RestEndpointIdentifier': {
                'IdentifierParts': {
                    'Method': 'string',
                    'Path': 'string',
                    'RestApiId': 'string',
                    'Stage': 'string'
                }
            },
            'Status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
            'StatusException': {
                'Exception': 'string',
                'Message': 'string'
            },
            'TryItState': 'ENABLED'|'DISABLED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Success
- Items (list) --
  
  The elements from this collection.
  - (dict) --
    
    A summary of a product REST endpoint page, without providing the page content.
    - Endpoint (string) --
      
      The endpoint of the product REST endpoint page.
    - LastModified (datetime) --
      
      The timestamp when the product REST endpoint page was last modified.
    - OperationName (string) --
      
      The operation name of the product REST endpoint.
    - ProductRestEndpointPageArn (string) --
      
      The ARN of the product REST endpoint page.
    - ProductRestEndpointPageId (string) --
      
      The product REST endpoint page identifier.
    - RestEndpointIdentifier (dict) --
      
      The REST endpoint identifier.
      - IdentifierParts (dict) --
        
        The identifier parts of the REST endpoint identifier.
        
        Method (string) --
        
        The method of the product REST endpoint.
        
        Path (string) --
        
        The path of the product REST endpoint.
        
        RestApiId (string) --
        
        The REST API ID of the product REST endpoint.
        
        Stage (string) --
        
        The stage of the product REST endpoint.
    - Status (string) --
      
      The status.
    - StatusException (dict) --
      
      The status exception information.
      - Exception (string) --
        
        The exception.
      - Message (string) --
        
        The error message.
    - TryItState (string) --
      
      The try it state of a product REST endpoint page.
- NextToken (string) --
  
  The next page of elements from this collection. Not valid for the last element of the collection.

GetProductRestEndpointPage (new)

Link ¶

Gets a product REST endpoint page.

See also: AWS API Documentation

Request Syntax

client.get_product_rest_endpoint_page(
    IncludeRawDisplayContent='string',
    PortalProductId='string',
    ProductRestEndpointPageId='string',
    ResourceOwnerAccountId='string'
)

type IncludeRawDisplayContent:

string

param IncludeRawDisplayContent:

The query parameter to include raw display content.

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type ProductRestEndpointPageId:

string

param ProductRestEndpointPageId:

[REQUIRED]

The product REST endpoint identifier.

type ResourceOwnerAccountId:

string

param ResourceOwnerAccountId:

The account ID of the resource owner of the portal product.

rtype:

dict

returns:

Response Syntax

{
    'DisplayContent': {
        'Body': 'string',
        'Endpoint': 'string',
        'OperationName': 'string'
    },
    'LastModified': datetime(2015, 1, 1),
    'ProductRestEndpointPageArn': 'string',
    'ProductRestEndpointPageId': 'string',
    'RawDisplayContent': 'string',
    'RestEndpointIdentifier': {
        'IdentifierParts': {
            'Method': 'string',
            'Path': 'string',
            'RestApiId': 'string',
            'Stage': 'string'
        }
    },
    'Status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
    'StatusException': {
        'Exception': 'string',
        'Message': 'string'
    },
    'TryItState': 'ENABLED'|'DISABLED'
}

Response Structure

(dict) --

Success
- DisplayContent (dict) --
  
  The content of the product REST endpoint page.
  - Body (string) --
    
    The API documentation.
  - Endpoint (string) --
    
    The URL to invoke your REST API.
  - OperationName (string) --
    
    The operation name.
- LastModified (datetime) --
  
  The timestamp when the product REST endpoint page was last modified.
- ProductRestEndpointPageArn (string) --
  
  The ARN of the product REST endpoint page.
- ProductRestEndpointPageId (string) --
  
  The product REST endpoint page identifier.
- RawDisplayContent (string) --
  
  The raw display content of the product REST endpoint page.
- RestEndpointIdentifier (dict) --
  
  The REST endpoint identifier.
  - IdentifierParts (dict) --
    
    The identifier parts of the REST endpoint identifier.
    - Method (string) --
      
      The method of the product REST endpoint.
    - Path (string) --
      
      The path of the product REST endpoint.
    - RestApiId (string) --
      
      The REST API ID of the product REST endpoint.
    - Stage (string) --
      
      The stage of the product REST endpoint.
- Status (string) --
  
  The status of the product REST endpoint page.
- StatusException (dict) --
  
  The status exception information.
  - Exception (string) --
    
    The exception.
  - Message (string) --
    
    The error message.
- TryItState (string) --
  
  The try it state.

CreateProductPage (new)

Link ¶

Creates a new product page for a portal product.

See also: AWS API Documentation

Request Syntax

client.create_product_page(
    DisplayContent={
        'Body': 'string',
        'Title': 'string'
    },
    PortalProductId='string'
)

type DisplayContent:

dict

param DisplayContent:

[REQUIRED]

The content of the product page.

Body (string) -- [REQUIRED]

The body.
Title (string) -- [REQUIRED]

The title.

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

rtype:

dict

returns:

Response Syntax

{
    'DisplayContent': {
        'Body': 'string',
        'Title': 'string'
    },
    'LastModified': datetime(2015, 1, 1),
    'ProductPageArn': 'string',
    'ProductPageId': 'string'
}

Response Structure

(dict) --

The request has succeeded and has resulted in the creation of a resource.
- DisplayContent (dict) --
  
  The content of the product page.
  - Body (string) --
    
    The body.
  - Title (string) --
    
    The title.
- LastModified (datetime) --
  
  The timestamp when the product page was last modified.
- ProductPageArn (string) --
  
  The ARN of the product page.
- ProductPageId (string) --
  
  The product page identifier.

CreateProductRestEndpointPage (new)

Link ¶

Creates a product REST endpoint page for a portal product.

See also: AWS API Documentation

Request Syntax

client.create_product_rest_endpoint_page(
    DisplayContent={
        'None': {}
        ,
        'Overrides': {
            'Body': 'string',
            'Endpoint': 'string',
            'OperationName': 'string'
        }
    },
    PortalProductId='string',
    RestEndpointIdentifier={
        'IdentifierParts': {
            'Method': 'string',
            'Path': 'string',
            'RestApiId': 'string',
            'Stage': 'string'
        }
    },
    TryItState='ENABLED'|'DISABLED'
)

type DisplayContent:

dict

param DisplayContent:

The content of the product REST endpoint page.

None (dict) --

If your product REST endpoint contains no overrides, the none object is returned.
Overrides (dict) --

The overrides for endpoint display content.
- Body (string) --
  
  By default, this is the documentation of your REST API from API Gateway. You can provide custom documentation to override this value.
- Endpoint (string) --
  
  The URL for your REST API. By default, API Gateway uses the default execute API endpoint. You can provide a custom domain to override this value.
- OperationName (string) --
  
  The operation name of the product REST endpoint.

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

type RestEndpointIdentifier:

dict

param RestEndpointIdentifier:

[REQUIRED]

The REST endpoint identifier.

IdentifierParts (dict) --

The identifier parts of the REST endpoint identifier.
- Method (string) -- [REQUIRED]
  
  The method of the product REST endpoint.
- Path (string) -- [REQUIRED]
  
  The path of the product REST endpoint.
- RestApiId (string) -- [REQUIRED]
  
  The REST API ID of the product REST endpoint.
- Stage (string) -- [REQUIRED]
  
  The stage of the product REST endpoint.

type TryItState:

string

param TryItState:

The try it state of the product REST endpoint page.

rtype:

dict

returns:

Response Syntax

{
    'DisplayContent': {
        'Body': 'string',
        'Endpoint': 'string',
        'OperationName': 'string'
    },
    'LastModified': datetime(2015, 1, 1),
    'ProductRestEndpointPageArn': 'string',
    'ProductRestEndpointPageId': 'string',
    'RestEndpointIdentifier': {
        'IdentifierParts': {
            'Method': 'string',
            'Path': 'string',
            'RestApiId': 'string',
            'Stage': 'string'
        }
    },
    'Status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
    'StatusException': {
        'Exception': 'string',
        'Message': 'string'
    },
    'TryItState': 'ENABLED'|'DISABLED'
}

Response Structure

(dict) --

The request has succeeded and has resulted in the creation of a resource.
- DisplayContent (dict) --
  
  The display content.
  - Body (string) --
    
    The API documentation.
  - Endpoint (string) --
    
    The URL to invoke your REST API.
  - OperationName (string) --
    
    The operation name.
- LastModified (datetime) --
  
  The timestamp when the product REST endpoint page was last modified.
- ProductRestEndpointPageArn (string) --
  
  The ARN of the product REST endpoint page.
- ProductRestEndpointPageId (string) --
  
  The product REST endpoint page identifier.
- RestEndpointIdentifier (dict) --
  
  The REST endpoint identifier.
  - IdentifierParts (dict) --
    
    The identifier parts of the REST endpoint identifier.
    - Method (string) --
      
      The method of the product REST endpoint.
    - Path (string) --
      
      The path of the product REST endpoint.
    - RestApiId (string) --
      
      The REST API ID of the product REST endpoint.
    - Stage (string) --
      
      The stage of the product REST endpoint.
- Status (string) --
  
  The status.
- StatusException (dict) --
  
  The status exception information.
  - Exception (string) --
    
    The exception.
  - Message (string) --
    
    The error message.
- TryItState (string) --
  
  The try it state.

UpdatePortalProduct (new)

Link ¶

Updates the portal product.

See also: AWS API Documentation

Request Syntax

client.update_portal_product(
    Description='string',
    DisplayName='string',
    DisplayOrder={
        'Contents': [
            {
                'ProductRestEndpointPageArns': [
                    'string',
                ],
                'SectionName': 'string'
            },
        ],
        'OverviewPageArn': 'string',
        'ProductPageArns': [
            'string',
        ]
    },
    PortalProductId='string'
)

type Description:

string

param Description:

The description.

type DisplayName:

string

param DisplayName:

The displayName.

type DisplayOrder:

dict

param DisplayOrder:

The display order.

Contents (list) --

Represents a list of sections which include section name and list of product REST endpoints for a product.
- (dict) --
  
  Contains the section name and list of product REST endpoints for a product.
  - ProductRestEndpointPageArns (list) -- [REQUIRED]
    
    The ARNs of the product REST endpoint pages in a portal product.
    - (string) --
  - SectionName (string) -- [REQUIRED]
    
    The section name.
OverviewPageArn (string) --

The ARN of the overview page.
ProductPageArns (list) --

The product page ARNs.
- (string) --

type PortalProductId:

string

param PortalProductId:

[REQUIRED]

The portal product identifier.

rtype:

dict

returns:

Response Syntax

{
    'Description': 'string',
    'DisplayName': 'string',
    'DisplayOrder': {
        'Contents': [
            {
                'ProductRestEndpointPageArns': [
                    'string',
                ],
                'SectionName': 'string'
            },
        ],
        'OverviewPageArn': 'string',
        'ProductPageArns': [
            'string',
        ]
    },
    'LastModified': datetime(2015, 1, 1),
    'PortalProductArn': 'string',
    'PortalProductId': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --

200 response
- Description (string) --
  
  The description of the portal product.
- DisplayName (string) --
  
  The display name of a portal product.
- DisplayOrder (dict) --
  
  The display order that the portal products will appear in a portal.
  - Contents (list) --
    
    Represents a list of sections which include section name and list of product REST endpoints for a product.
    - (dict) --
      
      Contains the section name and list of product REST endpoints for a product.
      - ProductRestEndpointPageArns (list) --
        
        The ARNs of the product REST endpoint pages in a portal product.
        
        (string) --
      - SectionName (string) --
        
        The section name.
  - OverviewPageArn (string) --
    
    The ARN of the overview page.
  - ProductPageArns (list) --
    
    The product page ARNs.
    - (string) --
- LastModified (datetime) --
  
  The timestamp when the portal product was last modified.
- PortalProductArn (string) --
  
  The ARN of the portal product.
- PortalProductId (string) --
  
  The portal product identifier.
- 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].