ESPRMAdminCognitoDomain
Defined in: src/ESPRMAdminCognitoDomain.ts:11
Shell class for admin Cognito domain operations. Methods are added via prototype augmentation in methods/ESPRMAdminCognitoDomain/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminCognitoDomain():
ESPRMAdminCognitoDomain
Returns
Section titled “Returns”ESPRMAdminCognitoDomain
Methods
Section titled “Methods”createCognitoDomain()
Section titled “createCognitoDomain()”createCognitoDomain(
params,queryParams?):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminCognitoDomain/CreateCognitoDomain.ts:31
Creates a custom Cognito domain for the user pool.
Parameters
Section titled “Parameters”params
Section titled “params”The domain configuration including domain_name.
queryParams?
Section titled “queryParams?”Optional query parameters, including email_mobile_userpool.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon creation.
deleteCognitoDomain()
Section titled “deleteCognitoDomain()”deleteCognitoDomain(
params?):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminCognitoDomain/DeleteCognitoDomain.ts:22
Deletes the Cognito domain from the user pool.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional parameters to identify the domain to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon deletion.
getCognitoDomain()
Section titled “getCognitoDomain()”getCognitoDomain(
params?):Promise<GetCognitoDomainResponse>
Defined in: src/methods/ESPRMAdminCognitoDomain/GetCognitoDomain.ts:22
Retrieves the Cognito domain configuration for the user pool.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters.
Returns
Section titled “Returns”Promise<GetCognitoDomainResponse>
The Cognito domain details.