You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoTSiteWise::Types::UpdatePortalRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTSiteWise::Types::UpdatePortalRequest
- Defined in:
- (unknown)
Overview
When passing UpdatePortalRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
portal_id: "ID", # required
portal_name: "Name", # required
portal_description: "Description",
portal_contact_email: "Email", # required
portal_logo_image: {
id: "ID",
file: {
data: "data", # required
type: "PNG", # required, accepts PNG
},
},
role_arn: "ARN", # required
client_token: "ClientToken",
}
Instance Attribute Summary collapse
-
#client_token ⇒ String
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
-
#portal_contact_email ⇒ String
The AWS administrator\'s contact email address.
-
#portal_description ⇒ String
A new description for the portal.
-
#portal_id ⇒ String
The ID of the portal to update.
-
#portal_logo_image ⇒ Types::Image
Contains an image that is one of the following:
-
An image file.
-
-
#portal_name ⇒ String
A new friendly name for the portal.
-
#role_arn ⇒ String
The [ARN][1] of a service role that allows the portal\'s users to access your AWS IoT SiteWise resources on your behalf.
Instance Attribute Details
#client_token ⇒ String
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.
#portal_contact_email ⇒ String
The AWS administrator\'s contact email address.
#portal_description ⇒ String
A new description for the portal.
#portal_id ⇒ String
The ID of the portal to update.
#portal_logo_image ⇒ Types::Image
Contains an image that is one of the following:
-
An image file. Choose this option to upload a new image.
-
The ID of an existing image. Choose this option to keep an existing image.
#portal_name ⇒ String
A new friendly name for the portal.
#role_arn ⇒ 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.