Class: Aws::IoTSiteWise::Types::UpdatePortalRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass UpdatePortalRequest data as a 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5208

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#portal_contact_emailString

The AWS administrator's contact email address.

Returns:

  • (String)


5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5208

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#portal_descriptionString

A new description for the portal.

Returns:

  • (String)


5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5208

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#portal_idString

The ID of the portal to update.

Returns:

  • (String)


5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5208

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#portal_logo_imageTypes::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.

Returns:



5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5208

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#portal_nameString

A new friendly name for the portal.

Returns:

  • (String)


5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5208

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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.

Returns:

  • (String)


5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5208

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end