Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListProblems

Lists the problems with your application.

Request Syntax


{
   "AccountId": "string",
   "ComponentName": "string",
   "EndTime": number,
   "MaxResults": number,
   "NextToken": "string",
   "ResourceGroupName": "string",
   "StartTime": number,
   "Visibility": "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.

AccountId

The AWS account ID for the resource group owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: No

ComponentName

The name of the component.

Type: String

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

Pattern: (?:^[\d\w\-_\.+]*$)|(?:^arn:aws(-\w+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$)

Required: No

EndTime

The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.

Type: Timestamp

Required: No

MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

Type: Integer

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

Required: No

NextToken

The token to request the next page of results.

Type: String

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

Pattern: .+

Required: No

ResourceGroupName

The name of the resource group.

Type: String

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

Pattern: [a-zA-Z0-9\.\-_]*

Required: No

StartTime

The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.

Type: Timestamp

Required: No

Visibility

Specifies whether or not you can view the problem. If not specified, visible and ignored problems are returned.

Type: String

Valid Values: IGNORED | VISIBLE

Required: No

Response Syntax


{
   "AccountId": "string",
   "NextToken": "string",
   "ProblemList": [ 
      { 
         "AccountId": "string",
         "AffectedResource": "string",
         "EndTime": number,
         "Feedback": { 
            "string" : "string" 
         },
         "Id": "string",
         "Insights": "string",
         "LastRecurrenceTime": number,
         "RecurringCount": number,
         "ResolutionMethod": "string",
         "ResourceGroupName": "string",
         "SeverityLevel": "string",
         "ShortName": "string",
         "StartTime": number,
         "Status": "string",
         "Title": "string",
         "Visibility": "string"
      }
   ],
   "ResourceGroupName": "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.

AccountId

The AWS account ID for the resource group owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

NextToken

The token used to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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

Pattern: .+

ProblemList

The list of problems.

Type: Array of Problem objects

ResourceGroupName

The name of the resource group.

Type: String

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

Pattern: [a-zA-Z0-9\.\-_]*

Errors

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

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 400

ResourceNotFoundException

The resource does not exist in the customer account.

HTTP Status Code: 400

ValidationException

The parameter is not valid.

HTTP Status Code: 400