1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package cognitoidentity
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/cognitoidentity/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Gets details about a particular identity pool, including the pool name, ID
15// description, creation date, and current number of users. You must use AWS
16// Developer credentials to call this API.
17func (c *Client) DescribeIdentityPool(ctx context.Context, params *DescribeIdentityPoolInput, optFns ...func(*Options)) (*DescribeIdentityPoolOutput, error) {
18	if params == nil {
19		params = &DescribeIdentityPoolInput{}
20	}
21
22	result, metadata, err := c.invokeOperation(ctx, "DescribeIdentityPool", params, optFns, addOperationDescribeIdentityPoolMiddlewares)
23	if err != nil {
24		return nil, err
25	}
26
27	out := result.(*DescribeIdentityPoolOutput)
28	out.ResultMetadata = metadata
29	return out, nil
30}
31
32// Input to the DescribeIdentityPool action.
33type DescribeIdentityPoolInput struct {
34
35	// An identity pool ID in the format REGION:GUID.
36	//
37	// This member is required.
38	IdentityPoolId *string
39}
40
41// An object representing an Amazon Cognito identity pool.
42type DescribeIdentityPoolOutput struct {
43
44	// TRUE if the identity pool supports unauthenticated logins.
45	//
46	// This member is required.
47	AllowUnauthenticatedIdentities bool
48
49	// An identity pool ID in the format REGION:GUID.
50	//
51	// This member is required.
52	IdentityPoolId *string
53
54	// A string that you provide.
55	//
56	// This member is required.
57	IdentityPoolName *string
58
59	// Enables or disables the Basic (Classic) authentication flow. For more
60	// information, see Identity Pools (Federated Identities) Authentication Flow
61	// (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html)
62	// in the Amazon Cognito Developer Guide.
63	AllowClassicFlow *bool
64
65	// A list representing an Amazon Cognito user pool and its client ID.
66	CognitoIdentityProviders []types.CognitoIdentityProvider
67
68	// The "domain" by which Cognito will refer to your users.
69	DeveloperProviderName *string
70
71	// The tags that are assigned to the identity pool. A tag is a label that you can
72	// apply to identity pools to categorize and manage them in different ways, such as
73	// by purpose, owner, environment, or other criteria.
74	IdentityPoolTags map[string]string
75
76	// The ARNs of the OpenID Connect providers.
77	OpenIdConnectProviderARNs []string
78
79	// An array of Amazon Resource Names (ARNs) of the SAML provider for your identity
80	// pool.
81	SamlProviderARNs []string
82
83	// Optional key:value pairs mapping provider names to provider app IDs.
84	SupportedLoginProviders map[string]string
85
86	// Metadata pertaining to the operation's result.
87	ResultMetadata middleware.Metadata
88}
89
90func addOperationDescribeIdentityPoolMiddlewares(stack *middleware.Stack, options Options) (err error) {
91	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeIdentityPool{}, middleware.After)
92	if err != nil {
93		return err
94	}
95	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeIdentityPool{}, middleware.After)
96	if err != nil {
97		return err
98	}
99	if err = addSetLoggerMiddleware(stack, options); err != nil {
100		return err
101	}
102	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
103		return err
104	}
105	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
106		return err
107	}
108	if err = addResolveEndpointMiddleware(stack, options); err != nil {
109		return err
110	}
111	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
112		return err
113	}
114	if err = addRetryMiddlewares(stack, options); err != nil {
115		return err
116	}
117	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
118		return err
119	}
120	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
121		return err
122	}
123	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
124		return err
125	}
126	if err = addClientUserAgent(stack); err != nil {
127		return err
128	}
129	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
130		return err
131	}
132	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
133		return err
134	}
135	if err = addOpDescribeIdentityPoolValidationMiddleware(stack); err != nil {
136		return err
137	}
138	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeIdentityPool(options.Region), middleware.Before); err != nil {
139		return err
140	}
141	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
142		return err
143	}
144	if err = addResponseErrorMiddleware(stack); err != nil {
145		return err
146	}
147	if err = addRequestResponseLogging(stack, options); err != nil {
148		return err
149	}
150	return nil
151}
152
153func newServiceMetadataMiddleware_opDescribeIdentityPool(region string) *awsmiddleware.RegisterServiceMetadata {
154	return &awsmiddleware.RegisterServiceMetadata{
155		Region:        region,
156		ServiceID:     ServiceID,
157		SigningName:   "cognito-identity",
158		OperationName: "DescribeIdentityPool",
159	}
160}
161