Policy
URI
/2017-08-29/policy
HTTP methods
GET
Operation ID: GetPolicy
Retrieve the JSON for your policy.
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | GetPolicyResponse | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | ExceptionBody | The service can't process your request because of a problem in the request. Please check your request form and syntax. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ExceptionBody | You don't have permissions for this action with the credentials you sent. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | ExceptionBody | The resource you requested does not exist. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ExceptionBody | The service could not complete your request because there is a conflict with the current state of the resource. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | ExceptionBody | Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | ExceptionBody | The service encountered an unexpected condition and cannot fulfill your request. |
PUT
Operation ID: PutPolicy
Create or change your policy. For more information about policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | PutPolicyResponse | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | ExceptionBody | The service can't process your request because of a problem in the request. Please check your request form and syntax. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ExceptionBody | You don't have permissions for this action with the credentials you sent. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | ExceptionBody | The resource you requested does not exist. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ExceptionBody | The service could not complete your request because there is a conflict with the current state of the resource. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | ExceptionBody | Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | ExceptionBody | The service encountered an unexpected condition and cannot fulfill your request. |
DELETE
Operation ID: DeletePolicy
Permanently delete a policy that you created.
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | DeletePolicyResponse | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | ExceptionBody | The service can't process your request because of a problem in the request. Please check your request form and syntax. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ExceptionBody | You don't have permissions for this action with the credentials you sent. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | ExceptionBody | The resource you requested does not exist. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ExceptionBody | The service could not complete your request because there is a conflict with the current state of the resource. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | ExceptionBody | Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | ExceptionBody | The service encountered an unexpected condition and cannot fulfill your request. |
OPTIONS
Supports CORS preflight requests.
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | The request completed successfully. |
Schemas
Request bodies
{ }
{ "policy": { "s3Inputs": enum, "httpInputs": enum, "httpsInputs": enum } }
{ }
Response bodies
{ "policy": { "s3Inputs": enum, "httpInputs": enum, "httpsInputs": enum } }
{ "policy": { "s3Inputs": enum, "httpInputs": enum, "httpsInputs": enum } }
{ }
{ "message": "string" }
Properties
DeletePolicyRequest
Send a request to permanently delete a policy that you created.
DeletePolicyResponse
Successful DELETE policy requests will return an OK message.
ExceptionBody
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
GetPolicyRequest
Send a request to retrieve the JSON for your policy.
GetPolicyResponse
Successful GET policy requests will return the JSON for your policy.
Property | Type | Required | Description |
---|---|---|---|
policy | False | A policy configures behavior that you allow or disallow for your account. For information about MediaConvert policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html |
InputPolicy
An input policy allows or disallows a job you submit to run based on the conditions that you specify.
ALLOWED
DISALLOWED
Policy
A policy configures behavior that you allow or disallow for your account. For information about MediaConvert policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
Property | Type | Required | Description |
---|---|---|---|
httpInputs | False | Allow or disallow jobs that specify HTTP inputs. | |
httpsInputs | False | Allow or disallow jobs that specify HTTPS inputs. | |
s3Inputs | False | Allow or disallow jobs that specify Amazon S3 inputs. |
PutPolicyRequest
Create or change a policy by sending a request that includes your policy in JSON.
Property | Type | Required | Description |
---|---|---|---|
policy | True | A policy configures behavior that you allow or disallow for your account. For information about MediaConvert policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html |
PutPolicyResponse
Successful PUT policy requests will return your policy.
Property | Type | Required | Description |
---|---|---|---|
policy | False | A policy configures behavior that you allow or disallow for your account. For information about MediaConvert policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: