apigateway:ListPortals

List

apigateway:ListPortals is a List access-level action in the apigateway service. Grants permission to list Portals

Resource types

ARNs that apigateway:ListPortals can be scoped to in an IAM policy.

arn:${Partition}:apigateway:${Region}:${Account}:/portals/${PortalId}
Portal

Condition keys

Keys you can use in the Condition block of a policy that grants apigateway:ListPortals.

apigateway:Resource/CognitoUserPoolArn ARN

Filters access by a Portal's CognitoUserPoolArn associated with the resource

apigateway:Resource/PortalDisplayName String

Filters access by a Portal's Display Name associated with the resource

apigateway:Resource/PortalDomainName String

Filters access by a Portal's vanity domain name associated with the resource

apigateway:Resource/PortalPublishStatus String

Filters access by a Portal's published status associated with the resource

aws:ResourceTag/${TagKey} String

Filters access by tag key-value pairs attached to the resource

Example IAM policy

A minimal policy that allows apigateway:ListPortals. Replace "Resource": "*" with a specific ARN to follow least privilege.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowApigatewayListPortals",
      "Effect": "Allow",
      "Action": "apigateway:ListPortals",
      "Resource": "*"
    }
  ]
}

Related actions in apigateway

View all apigateway actions →