CreatePortalRequest

public struct CreatePortalRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    Declaration

    Swift

    public let clientToken: String?

  • The AWS administrator’s contact email address.

    Declaration

    Swift

    public let portalContactEmail: String

  • A description for the portal.

    Declaration

    Swift

    public let portalDescription: String?

  • A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

    Declaration

    Swift

    public let portalLogoImageFile: ImageFile?

  • A friendly name for the portal.

    Declaration

    Swift

    public let portalName: String

  • The ARN of a service role that allows the portal’s users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

    Declaration

    Swift

    public let roleArn: String

  • A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

    Declaration

    Swift

    public let tags: [String : String]?

  • Undocumented

    Declaration

    Swift

    public init(clientToken: String? = CreatePortalRequest.idempotencyToken(), portalContactEmail: String, portalDescription: String? = nil, portalLogoImageFile: ImageFile? = nil, portalName: String, roleArn: String, tags: [String : String]? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws