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
|
// 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"
)
// Retrieves a paginated list of properties associated with an asset. If you
// update properties associated with the model before you finish listing all the
// properties, you need to start all over again.
func (c *Client) ListAssetProperties(ctx context.Context, params *ListAssetPropertiesInput, optFns ...func(*Options)) (*ListAssetPropertiesOutput, error) {
if params == nil {
params = &ListAssetPropertiesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListAssetProperties", params, optFns, c.addOperationListAssetPropertiesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListAssetPropertiesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListAssetPropertiesInput struct {
// The ID of the asset. This can be either the actual ID in UUID format, or else
// externalId: followed by the external ID, if it has one. For more information,
// see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
// in the IoT SiteWise User Guide.
//
// This member is required.
AssetId *string
// Filters the requested list of asset properties. You can choose one of the
// following options:
// - ALL – The list includes all asset properties for a given asset model ID.
// - BASE – The list includes only base asset properties for a given asset model
// ID.
// Default: BASE
Filter types.ListAssetPropertiesFilter
// The maximum number of results to return for each paginated request. If not
// specified, the default value is 50.
MaxResults *int32
// The token to be used for the next set of paginated results.
NextToken *string
noSmithyDocumentSerde
}
type ListAssetPropertiesOutput struct {
// A list that summarizes the properties associated with the specified asset.
//
// This member is required.
AssetPropertySummaries []types.AssetPropertySummary
// The token for the next set of results, or null if there are no additional
// results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListAssetPropertiesMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpListAssetProperties{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListAssetProperties{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ListAssetProperties"); 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_opListAssetPropertiesMiddleware(stack); err != nil {
return err
}
if err = addOpListAssetPropertiesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListAssetProperties(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_opListAssetPropertiesMiddleware struct {
}
func (*endpointPrefix_opListAssetPropertiesMiddleware) ID() string {
return "EndpointHostPrefix"
}
func (m *endpointPrefix_opListAssetPropertiesMiddleware) 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 = "api." + req.URL.Host
return next.HandleFinalize(ctx, in)
}
func addEndpointPrefix_opListAssetPropertiesMiddleware(stack *middleware.Stack) error {
return stack.Finalize.Insert(&endpointPrefix_opListAssetPropertiesMiddleware{}, "ResolveEndpointV2", middleware.After)
}
// ListAssetPropertiesAPIClient is a client that implements the
// ListAssetProperties operation.
type ListAssetPropertiesAPIClient interface {
ListAssetProperties(context.Context, *ListAssetPropertiesInput, ...func(*Options)) (*ListAssetPropertiesOutput, error)
}
var _ ListAssetPropertiesAPIClient = (*Client)(nil)
// ListAssetPropertiesPaginatorOptions is the paginator options for
// ListAssetProperties
type ListAssetPropertiesPaginatorOptions struct {
// The maximum number of results to return for each paginated request. If not
// specified, the default value is 50.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListAssetPropertiesPaginator is a paginator for ListAssetProperties
type ListAssetPropertiesPaginator struct {
options ListAssetPropertiesPaginatorOptions
client ListAssetPropertiesAPIClient
params *ListAssetPropertiesInput
nextToken *string
firstPage bool
}
// NewListAssetPropertiesPaginator returns a new ListAssetPropertiesPaginator
func NewListAssetPropertiesPaginator(client ListAssetPropertiesAPIClient, params *ListAssetPropertiesInput, optFns ...func(*ListAssetPropertiesPaginatorOptions)) *ListAssetPropertiesPaginator {
if params == nil {
params = &ListAssetPropertiesInput{}
}
options := ListAssetPropertiesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListAssetPropertiesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListAssetPropertiesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListAssetProperties page.
func (p *ListAssetPropertiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetPropertiesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListAssetProperties(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListAssetProperties(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ListAssetProperties",
}
}
|