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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package servicecatalog
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/servicecatalog/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns a summary of each of the portfolio shares that were created for the
// specified portfolio.
//
// You can use this API to determine which accounts or organizational nodes this
// portfolio have been shared, whether the recipient entity has imported the share,
// and whether TagOptions are included with the share.
//
// The PortfolioId and Type parameters are both required.
func (c *Client) DescribePortfolioShares(ctx context.Context, params *DescribePortfolioSharesInput, optFns ...func(*Options)) (*DescribePortfolioSharesOutput, error) {
if params == nil {
params = &DescribePortfolioSharesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribePortfolioShares", params, optFns, c.addOperationDescribePortfolioSharesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribePortfolioSharesOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribePortfolioSharesInput struct {
// The unique identifier of the portfolio for which shares will be retrieved.
//
// This member is required.
PortfolioId *string
// The type of portfolio share to summarize. This field acts as a filter on the
// type of portfolio share, which can be one of the following:
//
// 1. ACCOUNT - Represents an external account to account share.
//
// 2. ORGANIZATION - Represents a share to an organization. This share is
// available to every account in the organization.
//
// 3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.
//
// 4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the
// organization.
//
// This member is required.
Type types.DescribePortfolioShareType
// The maximum number of items to return with this call.
PageSize int32
// The page token for the next set of results. To retrieve the first set of
// results, use null.
PageToken *string
noSmithyDocumentSerde
}
type DescribePortfolioSharesOutput struct {
// The page token to use to retrieve the next set of results. If there are no
// additional results, this value is null.
NextPageToken *string
// Summaries about each of the portfolio shares.
PortfolioShareDetails []types.PortfolioShareDetail
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribePortfolioSharesMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribePortfolioShares{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribePortfolioShares{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribePortfolioShares"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpDescribePortfolioSharesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribePortfolioShares(options.Region), middleware.Before); err != nil {
return err
}
if err = 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
}
// DescribePortfolioSharesPaginatorOptions is the paginator options for
// DescribePortfolioShares
type DescribePortfolioSharesPaginatorOptions struct {
// The maximum number of items to return with this call.
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
}
// DescribePortfolioSharesPaginator is a paginator for DescribePortfolioShares
type DescribePortfolioSharesPaginator struct {
options DescribePortfolioSharesPaginatorOptions
client DescribePortfolioSharesAPIClient
params *DescribePortfolioSharesInput
nextToken *string
firstPage bool
}
// NewDescribePortfolioSharesPaginator returns a new
// DescribePortfolioSharesPaginator
func NewDescribePortfolioSharesPaginator(client DescribePortfolioSharesAPIClient, params *DescribePortfolioSharesInput, optFns ...func(*DescribePortfolioSharesPaginatorOptions)) *DescribePortfolioSharesPaginator {
if params == nil {
params = &DescribePortfolioSharesInput{}
}
options := DescribePortfolioSharesPaginatorOptions{}
if params.PageSize != 0 {
options.Limit = params.PageSize
}
for _, fn := range optFns {
fn(&options)
}
return &DescribePortfolioSharesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.PageToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribePortfolioSharesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next DescribePortfolioShares page.
func (p *DescribePortfolioSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePortfolioSharesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.PageToken = p.nextToken
params.PageSize = p.options.Limit
optFns = append([]func(*Options){
addIsPaginatorUserAgent,
}, optFns...)
result, err := p.client.DescribePortfolioShares(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextPageToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
// DescribePortfolioSharesAPIClient is a client that implements the
// DescribePortfolioShares operation.
type DescribePortfolioSharesAPIClient interface {
DescribePortfolioShares(context.Context, *DescribePortfolioSharesInput, ...func(*Options)) (*DescribePortfolioSharesOutput, error)
}
var _ DescribePortfolioSharesAPIClient = (*Client)(nil)
func newServiceMetadataMiddleware_opDescribePortfolioShares(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribePortfolioShares",
}
}
|