1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package iotsitewise
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/iotsitewise/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a portal, which can contain projects and dashboards. IoT SiteWise
// Monitor uses IAM Identity Center or IAM to authenticate portal users and manage
// user permissions. Before you can sign in to a new portal, you must add at least
// one identity to that portal. For more information, see Adding or removing
// portal administrators (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins)
// in the IoT SiteWise User Guide.
func (c *Client) CreatePortal(ctx context.Context, params *CreatePortalInput, optFns ...func(*Options)) (*CreatePortalOutput, error) {
if params == nil {
params = &CreatePortalInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreatePortal", params, optFns, c.addOperationCreatePortalMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreatePortalOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreatePortalInput struct {
// The Amazon Web Services administrator's contact email address.
//
// This member is required.
PortalContactEmail *string
// A friendly name for the portal.
//
// This member is required.
PortalName *string
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of a service role that allows the portal's users to access your IoT SiteWise
// resources on your behalf. For more information, see Using service roles for IoT
// SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
// in the IoT SiteWise User Guide.
//
// This member is required.
RoleArn *string
// Contains the configuration information of an alarm created in an IoT SiteWise
// Monitor portal. You can use the alarm to monitor an asset property and get
// notified when the asset property value is outside a specified range. For more
// information, see Monitoring with alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html)
// in the IoT SiteWise Application Guide.
Alarms *types.Alarms
// 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.
ClientToken *string
// The email address that sends alarm notifications. If you use the IoT Events
// managed Lambda function (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html)
// to manage your emails, you must verify the sender email address in Amazon SES (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html)
// .
NotificationSenderEmail *string
// The service to use to authenticate users to the portal. Choose from the
// following options:
// - SSO – The portal uses IAM Identity Center to authenticate users and manage
// user permissions. Before you can create a portal that uses IAM Identity Center,
// you must enable IAM Identity Center. For more information, see Enabling IAM
// Identity Center (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso)
// in the IoT SiteWise User Guide. This option is only available in Amazon Web
// Services Regions other than the China Regions.
// - IAM – The portal uses Identity and Access Management to authenticate users
// and manage user permissions.
// You can't change this value after you create a portal. Default: SSO
PortalAuthMode types.AuthMode
// A description for the portal.
PortalDescription *string
// A logo image to display in the portal. Upload a square, high-resolution image.
// The image is displayed on a dark background.
PortalLogoImageFile *types.ImageFile
// A list of key-value pairs that contain metadata for the portal. For more
// information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
// in the IoT SiteWise User Guide.
Tags map[string]string
noSmithyDocumentSerde
}
type CreatePortalOutput struct {
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the portal, which has the following format.
// arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
//
// This member is required.
PortalArn *string
// The ID of the created portal.
//
// This member is required.
PortalId *string
// The URL for the IoT SiteWise Monitor portal. You can use this URL to access
// portals that use IAM Identity Center for authentication. For portals that use
// IAM for authentication, you must use the IoT SiteWise console to get a URL that
// you can use to access the portal.
//
// This member is required.
PortalStartUrl *string
// The status of the portal, which contains a state ( CREATING after successfully
// calling this operation) and any error message.
//
// This member is required.
PortalStatus *types.PortalStatus
// The associated IAM Identity Center application ID, if the portal uses IAM
// Identity Center.
//
// This member is required.
SsoApplicationId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreatePortalMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreatePortal{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreatePortal{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreatePortal"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addEndpointPrefix_opCreatePortalMiddleware(stack); err != nil {
return err
}
if err = addIdempotencyToken_opCreatePortalMiddleware(stack, options); err != nil {
return err
}
if err = addOpCreatePortalValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreatePortal(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
type endpointPrefix_opCreatePortalMiddleware struct {
}
func (*endpointPrefix_opCreatePortalMiddleware) ID() string {
return "EndpointHostPrefix"
}
func (m *endpointPrefix_opCreatePortalMiddleware) HandleFinalize(ctx context.Context, in middleware.FinalizeInput, next middleware.FinalizeHandler) (
out middleware.FinalizeOutput, metadata middleware.Metadata, err error,
) {
if smithyhttp.GetHostnameImmutable(ctx) || smithyhttp.IsEndpointHostPrefixDisabled(ctx) {
return next.HandleFinalize(ctx, in)
}
req, ok := in.Request.(*smithyhttp.Request)
if !ok {
return out, metadata, fmt.Errorf("unknown transport type %T", in.Request)
}
req.URL.Host = "monitor." + req.URL.Host
return next.HandleFinalize(ctx, in)
}
func addEndpointPrefix_opCreatePortalMiddleware(stack *middleware.Stack) error {
return stack.Finalize.Insert(&endpointPrefix_opCreatePortalMiddleware{}, "ResolveEndpointV2", middleware.After)
}
type idempotencyToken_initializeOpCreatePortal struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpCreatePortal) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpCreatePortal) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*CreatePortalInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *CreatePortalInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opCreatePortalMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpCreatePortal{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opCreatePortal(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreatePortal",
}
}
|