Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeProtection

Lists the details of a Protection object.

Request Syntax


{
   "ProtectionId": "string",
   "ResourceArn": "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.

ProtectionId

The unique identifier (ID) for the Protection object to describe. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

Type: String

Length Constraints: Fixed length of 36.

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

Required: No

ResourceArn

The ARN (Amazon Resource Name) of the protected AWS resource. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

Type: String

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

Pattern: ^arn:aws.*

Required: No

Response Syntax


{
   "Protection": { 
      "ApplicationLayerAutomaticResponseConfiguration": { 
         "Action": { 
            "Block": { 
            },
            "Count": { 
            }
         },
         "Status": "string"
      },
      "HealthCheckIds": [ "string" ],
      "Id": "string",
      "Name": "string",
      "ProtectionArn": "string",
      "ResourceArn": "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.

Protection

The Protection that you requested.

Type: Protection object

Errors

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

InternalErrorException

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

HTTP Status Code: 500

InvalidParameterException

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

fields: Fields that caused the exception.
reason: Additional information about the exception.

HTTP Status Code: 400

ResourceNotFoundException

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

resourceType: Type of resource.

HTTP Status Code: 400