PutEndpointPolicy
Attaches a resource-based policy to an endpoint. With an endpoint policy, you can allow other AWS accounts to send requests to your endpoint, or to inference components on it, through an inference router. The policy that you specify replaces the endpoint's existing policy, if it has one.
You can't attach a policy to an endpoint whose status is Deleting or
Failed. SageMaker AI
rejects a policy that doesn't follow the endpoint policy rules. For information about the
policy rules, see Use destinations in other
accounts.
Policy changes typically take effect within 30 seconds, and can take up to 5 minutes. If you delete the endpoint, its policy is also deleted, and a new endpoint with the same name has no policy.
Request Syntax
{
"EndpointName": "string",
"ResourcePolicy": "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
- ResourcePolicy
-
The endpoint policy, as a JSON policy document. The policy can contain only ASCII characters. For information about the policy rules, see Use destinations in other accounts.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20480.
Pattern:
.*(?:[ \r\n\t].*)*.*Required: Yes
Response Syntax
{
"EndpointArn": "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/.*
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: