| Package | Description |
|---|---|
| com.amazonaws.services.iotsitewise |
Welcome to the AWS IoT SiteWise API Reference.
|
| com.amazonaws.services.iotsitewise.model | |
| com.amazonaws.services.iotsitewise.waiters |
| Modifier and Type | Method and Description |
|---|---|
DescribePortalResult |
AWSIoTSiteWiseClient.describePortal(DescribePortalRequest request)
Retrieves information about a portal.
|
DescribePortalResult |
AWSIoTSiteWise.describePortal(DescribePortalRequest describePortalRequest)
Retrieves information about a portal.
|
DescribePortalResult |
AbstractAWSIoTSiteWise.describePortal(DescribePortalRequest request) |
| Modifier and Type | Method and Description |
|---|---|
Future<DescribePortalResult> |
AWSIoTSiteWiseAsync.describePortalAsync(DescribePortalRequest describePortalRequest,
AsyncHandler<DescribePortalRequest,DescribePortalResult> asyncHandler)
Retrieves information about a portal.
|
Future<DescribePortalResult> |
AWSIoTSiteWiseAsyncClient.describePortalAsync(DescribePortalRequest request,
AsyncHandler<DescribePortalRequest,DescribePortalResult> asyncHandler) |
Future<DescribePortalResult> |
AbstractAWSIoTSiteWiseAsync.describePortalAsync(DescribePortalRequest request,
AsyncHandler<DescribePortalRequest,DescribePortalResult> asyncHandler) |
| Modifier and Type | Method and Description |
|---|---|
DescribePortalResult |
DescribePortalResult.clone() |
DescribePortalResult |
DescribePortalResult.withPortalArn(String portalArn)
The ARN of the portal,
which has the following format.
|
DescribePortalResult |
DescribePortalResult.withPortalAuthMode(AuthMode portalAuthMode)
The service to use to authenticate users to the portal.
|
DescribePortalResult |
DescribePortalResult.withPortalAuthMode(String portalAuthMode)
The service to use to authenticate users to the portal.
|
DescribePortalResult |
DescribePortalResult.withPortalClientId(String portalClientId)
The AWS SSO application generated client ID (used with AWS SSO APIs).
|
DescribePortalResult |
DescribePortalResult.withPortalContactEmail(String portalContactEmail)
The AWS administrator's contact email address.
|
DescribePortalResult |
DescribePortalResult.withPortalCreationDate(Date portalCreationDate)
The date the portal was created, in Unix epoch time.
|
DescribePortalResult |
DescribePortalResult.withPortalDescription(String portalDescription)
The portal's description.
|
DescribePortalResult |
DescribePortalResult.withPortalId(String portalId)
The ID of the portal.
|
DescribePortalResult |
DescribePortalResult.withPortalLastUpdateDate(Date portalLastUpdateDate)
The date the portal was last updated, in Unix epoch time.
|
DescribePortalResult |
DescribePortalResult.withPortalLogoImageLocation(ImageLocation portalLogoImageLocation)
The portal's logo image, which is available at a URL.
|
DescribePortalResult |
DescribePortalResult.withPortalName(String portalName)
The name of the portal.
|
DescribePortalResult |
DescribePortalResult.withPortalStartUrl(String portalStartUrl)
The URL for the AWS IoT SiteWise Monitor portal.
|
DescribePortalResult |
DescribePortalResult.withPortalStatus(PortalStatus portalStatus)
The current status of the portal, which contains a state and any error message.
|
DescribePortalResult |
DescribePortalResult.withRoleArn(String roleArn)
The ARN of the service
role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
|
| Modifier and Type | Method and Description |
|---|---|
DescribePortalResult |
DescribePortalFunction.apply(DescribePortalRequest describePortalRequest)
Makes a call to the operation specified by the waiter by taking the corresponding request and returns the
corresponding result
|
Copyright © 2021. All rights reserved.