DescribeUserStackAssociations
Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:
-
The stack name
-
The user name (email address of the user associated with the stack) and the authentication type for the user
Request Syntax
{ "AuthenticationType": "
string
", "MaxResults":number
, "NextToken": "string
", "StackName": "string
", "UserName": "string
" }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AuthenticationType
-
The authentication type for the user who is associated with the stack. You must specify USERPOOL.
Type: String
Valid Values:
API | SAML | USERPOOL
Required: No
- MaxResults
-
The maximum size of each page of results.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 500.
Required: No
- NextToken
-
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- StackName
-
The name of the stack that is associated with the user.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- UserName
-
The email address of the user who is associated with the stack.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: No
Response Syntax
{ "NextToken": "string", "UserStackAssociations": [ { "AuthenticationType": "string", "SendEmailNotification": boolean, "StackName": "string", "UserName": "string" } ] }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Type: String
Length Constraints: Minimum length of 1.
- UserStackAssociations
-
The UserStackAssociation objects.
Type: Array of UserStackAssociation objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterCombinationException
-
Indicates an incorrect combination of parameters, or a missing parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: