Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAssociations

Lists resources associated with a channel configuration.

Request Syntax


POST /list-associations HTTP/1.1
Content-type: application/json

{
   "ChatConfiguration": "string",
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ChatConfiguration

The channel configuration to list associations for.

Type: String

Length Constraints: Minimum length of 19. Maximum length of 1169.

Pattern: arn:aws:(wheatley|chatbot):[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}

Required: Yes

MaxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\x20-\x7F]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Associations": [ 
      { 
         "Resource": "string"
      }
   ],
   "NextToken": "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.

Associations

The resources associated with this channel configuration.

Type: Array of AssociationListing objects

NextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\x20-\x7F]+

Errors

For information about the errors that are common to all actions, see Common Errors.