Policy - AWS Elemental MediaConvert API Reference
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Policy

URI

/2017-08-29/policy

HTTP methods

GET

Operation ID: GetPolicy

Retrieve the JSON for your policy.

Responses
Status codeResponse modelDescription
200GetPolicyResponse

200 response

400ExceptionBody

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403ExceptionBody

You don't have permissions for this action with the credentials you sent.

404ExceptionBody

The resource you requested does not exist.

409ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500ExceptionBody

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 codeResponse modelDescription
200PutPolicyResponse

200 response

400ExceptionBody

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403ExceptionBody

You don't have permissions for this action with the credentials you sent.

404ExceptionBody

The resource you requested does not exist.

409ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500ExceptionBody

The service encountered an unexpected condition and cannot fulfill your request.

DELETE

Operation ID: DeletePolicy

Permanently delete a policy that you created.

Responses
Status codeResponse modelDescription
200DeletePolicyResponse

200 response

400ExceptionBody

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403ExceptionBody

You don't have permissions for this action with the credentials you sent.

404ExceptionBody

The resource you requested does not exist.

409ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500ExceptionBody

The service encountered an unexpected condition and cannot fulfill your request.

OPTIONS

Supports CORS preflight requests.

Responses
Status codeResponse modelDescription
200None

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

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
policy

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

PropertyTypeRequiredDescription
httpInputs

InputPolicy

False

Allow or disallow jobs that specify HTTP inputs.

httpsInputs

InputPolicy

False

Allow or disallow jobs that specify HTTPS inputs.

s3Inputs

InputPolicy

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.

PropertyTypeRequiredDescription
policy

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.

PropertyTypeRequiredDescription
policy

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