PutResourcePolicy
Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.
Request Syntax
{
"Policy": "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.
- Policy
-
The JSON formatted resource-based policy to attach.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10000.
Required: Yes
- ResourceArn
-
The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource to attach the resource-based policy to.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 256.
Pattern:
arn:[A-Za-z0-9_:/-]+
Required: Yes
Response Syntax
{
"CreatedTimestamp": number,
"Policy": "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.
- CreatedTimestamp
-
The time when the resource-based policy was created, in UNIX epoch time
format. Type: Timestamp
- Policy
-
The JSON formatted Resource Policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10000.
- ResourceArn
-
The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 256.
Pattern:
arn:[A-Za-z0-9_:/-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because you don't have sufficient permissions to access the resource.
HTTP Status Code: 400
- InternalServerException
-
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
HTTP Status Code: 500
- ResourceNotFoundException
-
A requested resource couldn't be found.
HTTP Status Code: 400
- ThrottlingException
-
An error that occurred because too many requests were sent during a certain amount of time.
HTTP Status Code: 400
- ValidationException
-
A validation exception for a field.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: