Skip to main content

portals_list_only

Lists portals in a region or regions, for all properties use portals

Overview

Nameportals_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type
Idaws.workspacesweb.portals_list_only

Fields

NameDatatypeDescription
additional_encryption_contextobject
authentication_typestring
browser_settings_arnstring
browser_typestring
creation_datestring
customer_managed_keystring
display_namestring
instance_typestring
ip_access_settings_arnstring
max_concurrent_sessionsnumber
network_settings_arnstring
portal_arnstring
portal_endpointstring
portal_statusstring
renderer_typestring
service_provider_saml_metadatastring
status_reasonstring
tagsarray
trust_store_arnstring
user_access_logging_settings_arnstring
user_settings_arnstring
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all portals in a region.

SELECT
region,
portal_arn
FROM aws.workspacesweb.portals_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the portals_list_only resource, see portals