GetEndpointPolicy
Returns the resource-based policy that is attached to an endpoint. If the endpoint doesn't
have a policy, you get a ValidationException.
Request Syntax
{
"EndpointName": "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.
- EndpointName
-
The name of the endpoint. The endpoint must be in your account and in the current AWS Region.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
Response Syntax
{
"EndpointArn": "string",
"EndpointName": "string",
"ResourcePolicy": "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.
- EndpointArn
-
The Amazon Resource Name (ARN) of the endpoint.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint/.* - EndpointName
-
The name of the endpoint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - ResourcePolicy
-
The endpoint policy, as a JSON policy document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20480.
Pattern:
.*(?:[ \r\n\t].*)*.*
Errors
For information about the errors that are common to all actions, see Common Error Types.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: