Struct aws_sdk_mediaconvert::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Elemental MediaConvert
Client for invoking operations on AWS Elemental MediaConvert. Each operation on AWS Elemental MediaConvert is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_mediaconvert::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_mediaconvert::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AssociateCertificate
operation has
a Client::associate_certificate
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_certificate()
.arn("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn associate_certificate(&self) -> AssociateCertificateFluentBuilder
pub fn associate_certificate(&self) -> AssociateCertificateFluentBuilder
Constructs a fluent builder for the AssociateCertificate
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: true
The ARN of the ACM certificate that you want to associate with your MediaConvert resource.
- On success, responds with
AssociateCertificateOutput
- On failure, responds with
SdkError<AssociateCertificateError>
source§impl Client
impl Client
sourcepub fn cancel_job(&self) -> CancelJobFluentBuilder
pub fn cancel_job(&self) -> CancelJobFluentBuilder
Constructs a fluent builder for the CancelJob
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: true
The Job ID of the job to be cancelled.
- On success, responds with
CancelJobOutput
- On failure, responds with
SdkError<CancelJobError>
source§impl Client
impl Client
sourcepub fn create_job(&self) -> CreateJobFluentBuilder
pub fn create_job(&self) -> CreateJobFluentBuilder
Constructs a fluent builder for the CreateJob
operation.
- The fluent builder is configurable:
acceleration_settings(AccelerationSettings)
/set_acceleration_settings(Option<AccelerationSettings>)
:
required: false
Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.billing_tags_source(BillingTagsSource)
/set_billing_tags_source(Option<BillingTagsSource>)
:
required: false
Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don’t have an associated tag will appear in your billing report unsorted. If you don’t choose a valid value for this field, your job outputs will appear on the billing report unsorted.client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false
Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.hop_destinations(HopDestination)
/set_hop_destinations(Option<Vec::<HopDestination>>)
:
required: false
Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.job_template(impl Into<String>)
/set_job_template(Option<String>)
:
required: false
Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.priority(i32)
/set_priority(Option<i32>)
:
required: false
Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don’t specify a priority, the service uses the default value 0.queue(impl Into<String>)
/set_queue(Option<String>)
:
required: false
Optional. When you create a job, you can specify a queue to send it to. If you don’t specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.role(impl Into<String>)
/set_role(Option<String>)
:
required: true
Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.settings(JobSettings)
/set_settings(Option<JobSettings>)
:
required: true
JobSettings contains all the transcode settings for a job.simulate_reserved_queue(SimulateReservedQueue)
/set_simulate_reserved_queue(Option<SimulateReservedQueue>)
:
required: false
Optional. Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.status_update_interval(StatusUpdateInterval)
/set_status_update_interval(Option<StatusUpdateInterval>)
:
required: false
Optional. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations and workflows.user_metadata(impl Into<String>, impl Into<String>)
/set_user_metadata(Option<HashMap::<String, String>>)
:
required: false
Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we recommend that you use standard AWS tags.
- On success, responds with
CreateJobOutput
with field(s):job(Option<Job>)
: Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
- On failure, responds with
SdkError<CreateJobError>
source§impl Client
impl Client
sourcepub fn create_job_template(&self) -> CreateJobTemplateFluentBuilder
pub fn create_job_template(&self) -> CreateJobTemplateFluentBuilder
Constructs a fluent builder for the CreateJobTemplate
operation.
- The fluent builder is configurable:
acceleration_settings(AccelerationSettings)
/set_acceleration_settings(Option<AccelerationSettings>)
:
required: false
Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.category(impl Into<String>)
/set_category(Option<String>)
:
required: false
Optional. A category for the job template you are creatingdescription(impl Into<String>)
/set_description(Option<String>)
:
required: false
Optional. A description of the job template you are creating.hop_destinations(HopDestination)
/set_hop_destinations(Option<Vec::<HopDestination>>)
:
required: false
Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the job template you are creating.priority(i32)
/set_priority(Option<i32>)
:
required: false
Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don’t specify a priority, the service uses the default value 0.queue(impl Into<String>)
/set_queue(Option<String>)
:
required: false
Optional. The queue that jobs created from this template are assigned to. If you don’t specify this, jobs will go to the default queue.settings(JobTemplateSettings)
/set_settings(Option<JobTemplateSettings>)
:
required: true
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.status_update_interval(StatusUpdateInterval)
/set_status_update_interval(Option<StatusUpdateInterval>)
:
required: false
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
- On success, responds with
CreateJobTemplateOutput
with field(s):job_template(Option<JobTemplate>)
: A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
- On failure, responds with
SdkError<CreateJobTemplateError>
source§impl Client
impl Client
sourcepub fn create_preset(&self) -> CreatePresetFluentBuilder
pub fn create_preset(&self) -> CreatePresetFluentBuilder
Constructs a fluent builder for the CreatePreset
operation.
- The fluent builder is configurable:
category(impl Into<String>)
/set_category(Option<String>)
:
required: false
Optional. A category for the preset you are creating.description(impl Into<String>)
/set_description(Option<String>)
:
required: false
Optional. A description of the preset you are creating.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the preset you are creating.settings(PresetSettings)
/set_settings(Option<PresetSettings>)
:
required: true
Settings for presettags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
- On success, responds with
CreatePresetOutput
with field(s):preset(Option<Preset>)
: A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
- On failure, responds with
SdkError<CreatePresetError>
source§impl Client
impl Client
sourcepub fn create_queue(&self) -> CreateQueueFluentBuilder
pub fn create_queue(&self) -> CreateQueueFluentBuilder
Constructs a fluent builder for the CreateQueue
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
Optional. A description of the queue that you are creating.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the queue that you are creating.pricing_plan(PricingPlan)
/set_pricing_plan(Option<PricingPlan>)
:
required: false
Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand.reservation_plan_settings(ReservationPlanSettings)
/set_reservation_plan_settings(Option<ReservationPlanSettings>)
:
required: false
Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.status(QueueStatus)
/set_status(Option<QueueStatus>)
:
required: false
Initial state of the queue. If you create a paused queue, then jobs in that queue won’t begin.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
- On success, responds with
CreateQueueOutput
with field(s):queue(Option<Queue>)
: You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don’t specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
- On failure, responds with
SdkError<CreateQueueError>
source§impl Client
impl Client
sourcepub fn delete_job_template(&self) -> DeleteJobTemplateFluentBuilder
pub fn delete_job_template(&self) -> DeleteJobTemplateFluentBuilder
Constructs a fluent builder for the DeleteJobTemplate
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the job template to be deleted.
- On success, responds with
DeleteJobTemplateOutput
- On failure, responds with
SdkError<DeleteJobTemplateError>
source§impl Client
impl Client
sourcepub fn delete_policy(&self) -> DeletePolicyFluentBuilder
pub fn delete_policy(&self) -> DeletePolicyFluentBuilder
Constructs a fluent builder for the DeletePolicy
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DeletePolicyOutput
- On failure, responds with
SdkError<DeletePolicyError>
source§impl Client
impl Client
sourcepub fn delete_preset(&self) -> DeletePresetFluentBuilder
pub fn delete_preset(&self) -> DeletePresetFluentBuilder
Constructs a fluent builder for the DeletePreset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the preset to be deleted.
- On success, responds with
DeletePresetOutput
- On failure, responds with
SdkError<DeletePresetError>
source§impl Client
impl Client
sourcepub fn delete_queue(&self) -> DeleteQueueFluentBuilder
pub fn delete_queue(&self) -> DeleteQueueFluentBuilder
Constructs a fluent builder for the DeleteQueue
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the queue that you want to delete.
- On success, responds with
DeleteQueueOutput
- On failure, responds with
SdkError<DeleteQueueError>
source§impl Client
impl Client
sourcepub fn describe_endpoints(&self) -> DescribeEndpointsFluentBuilder
👎Deprecated: DescribeEndpoints and account specific endpoints are no longer required. We recommend that you send your requests directly to the regional endpoint instead.
pub fn describe_endpoints(&self) -> DescribeEndpointsFluentBuilder
Constructs a fluent builder for the DescribeEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Optional. Max number of endpoints, up to twenty, that will be returned at one time.mode(DescribeEndpointsMode)
/set_mode(Option<DescribeEndpointsMode>)
:
required: false
Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn’t already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Use this string, provided with the response to a previous request, to request the next batch of endpoints.
- On success, responds with
DescribeEndpointsOutput
with field(s):endpoints(Option<Vec::<Endpoint>>)
: List of endpointsnext_token(Option<String>)
: Use this string to request the next batch of endpoints.
- On failure, responds with
SdkError<DescribeEndpointsError>
source§impl Client
impl Client
sourcepub fn disassociate_certificate(&self) -> DisassociateCertificateFluentBuilder
pub fn disassociate_certificate(&self) -> DisassociateCertificateFluentBuilder
Constructs a fluent builder for the DisassociateCertificate
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: true
The ARN of the ACM certificate that you want to disassociate from your MediaConvert resource.
- On success, responds with
DisassociateCertificateOutput
- On failure, responds with
SdkError<DisassociateCertificateError>
source§impl Client
impl Client
sourcepub fn get_job(&self) -> GetJobFluentBuilder
pub fn get_job(&self) -> GetJobFluentBuilder
Constructs a fluent builder for the GetJob
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: true
the job ID of the job.
- On success, responds with
GetJobOutput
with field(s):job(Option<Job>)
: Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
- On failure, responds with
SdkError<GetJobError>
source§impl Client
impl Client
sourcepub fn get_job_template(&self) -> GetJobTemplateFluentBuilder
pub fn get_job_template(&self) -> GetJobTemplateFluentBuilder
Constructs a fluent builder for the GetJobTemplate
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the job template.
- On success, responds with
GetJobTemplateOutput
with field(s):job_template(Option<JobTemplate>)
: A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
- On failure, responds with
SdkError<GetJobTemplateError>
source§impl Client
impl Client
sourcepub fn get_policy(&self) -> GetPolicyFluentBuilder
pub fn get_policy(&self) -> GetPolicyFluentBuilder
Constructs a fluent builder for the GetPolicy
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetPolicyOutput
with field(s):policy(Option<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
- On failure, responds with
SdkError<GetPolicyError>
source§impl Client
impl Client
sourcepub fn get_preset(&self) -> GetPresetFluentBuilder
pub fn get_preset(&self) -> GetPresetFluentBuilder
Constructs a fluent builder for the GetPreset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the preset.
- On success, responds with
GetPresetOutput
with field(s):preset(Option<Preset>)
: A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
- On failure, responds with
SdkError<GetPresetError>
source§impl Client
impl Client
sourcepub fn get_queue(&self) -> GetQueueFluentBuilder
pub fn get_queue(&self) -> GetQueueFluentBuilder
Constructs a fluent builder for the GetQueue
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the queue that you want information about.
- On success, responds with
GetQueueOutput
with field(s):queue(Option<Queue>)
: You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don’t specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
- On failure, responds with
SdkError<GetQueueError>
source§impl Client
impl Client
sourcepub fn list_job_templates(&self) -> ListJobTemplatesFluentBuilder
pub fn list_job_templates(&self) -> ListJobTemplatesFluentBuilder
Constructs a fluent builder for the ListJobTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
category(impl Into<String>)
/set_category(Option<String>)
:
required: false
Optionally, specify a job template category to limit responses to only job templates from that category.list_by(JobTemplateListBy)
/set_list_by(Option<JobTemplateListBy>)
:
required: false
Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don’t specify, the service will list them by name.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Optional. Number of job templates, up to twenty, that will be returned at one time.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Use this string, provided with the response to a previous request, to request the next batch of job templates.order(Order)
/set_order(Option<Order>)
:
required: false
Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
- On success, responds with
ListJobTemplatesOutput
with field(s):job_templates(Option<Vec::<JobTemplate>>)
: List of Job templates.next_token(Option<String>)
: Use this string to request the next batch of job templates.
- On failure, responds with
SdkError<ListJobTemplatesError>
source§impl Client
impl Client
sourcepub fn list_jobs(&self) -> ListJobsFluentBuilder
pub fn list_jobs(&self) -> ListJobsFluentBuilder
Constructs a fluent builder for the ListJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Optional. Number of jobs, up to twenty, that will be returned at one time.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.order(Order)
/set_order(Option<Order>)
:
required: false
Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.queue(impl Into<String>)
/set_queue(Option<String>)
:
required: false
Optional. Provide a queue name to get back only jobs from that queue.status(JobStatus)
/set_status(Option<JobStatus>)
:
required: false
Optional. A job’s status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
- On success, responds with
ListJobsOutput
with field(s):jobs(Option<Vec::<Job>>)
: List of jobsnext_token(Option<String>)
: Use this string to request the next batch of jobs.
- On failure, responds with
SdkError<ListJobsError>
source§impl Client
impl Client
sourcepub fn list_presets(&self) -> ListPresetsFluentBuilder
pub fn list_presets(&self) -> ListPresetsFluentBuilder
Constructs a fluent builder for the ListPresets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
category(impl Into<String>)
/set_category(Option<String>)
:
required: false
Optionally, specify a preset category to limit responses to only presets from that category.list_by(PresetListBy)
/set_list_by(Option<PresetListBy>)
:
required: false
Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don’t specify, the service will list them by name.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Optional. Number of presets, up to twenty, that will be returned at one timenext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Use this string, provided with the response to a previous request, to request the next batch of presets.order(Order)
/set_order(Option<Order>)
:
required: false
Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
- On success, responds with
ListPresetsOutput
with field(s):next_token(Option<String>)
: Use this string to request the next batch of presets.presets(Option<Vec::<Preset>>)
: List of presets
- On failure, responds with
SdkError<ListPresetsError>
source§impl Client
impl Client
sourcepub fn list_queues(&self) -> ListQueuesFluentBuilder
pub fn list_queues(&self) -> ListQueuesFluentBuilder
Constructs a fluent builder for the ListQueues
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
list_by(QueueListBy)
/set_list_by(Option<QueueListBy>)
:
required: false
Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don’t specify, the service will list them by creation date.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Optional. Number of queues, up to twenty, that will be returned at one time.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Use this string, provided with the response to a previous request, to request the next batch of queues.order(Order)
/set_order(Option<Order>)
:
required: false
Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
- On success, responds with
ListQueuesOutput
with field(s):next_token(Option<String>)
: Use this string to request the next batch of queues.queues(Option<Vec::<Queue>>)
: List of queues.
- On failure, responds with
SdkError<ListQueuesError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the resource that you want to list tags for. To get the ARN, send a GET request with the resource name.
- On success, responds with
ListTagsForResourceOutput
with field(s):resource_tags(Option<ResourceTags>)
: The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn put_policy(&self) -> PutPolicyFluentBuilder
pub fn put_policy(&self) -> PutPolicyFluentBuilder
Constructs a fluent builder for the PutPolicy
operation.
- The fluent builder is configurable:
policy(Policy)
/set_policy(Option<Policy>)
:
required: 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
- On success, responds with
PutPolicyOutput
with field(s):policy(Option<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
- On failure, responds with
SdkError<PutPolicyError>
source§impl Client
impl Client
sourcepub fn search_jobs(&self) -> SearchJobsFluentBuilder
pub fn search_jobs(&self) -> SearchJobsFluentBuilder
Constructs a fluent builder for the SearchJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
input_file(impl Into<String>)
/set_input_file(Option<String>)
:
required: false
Optional. Provide your input file URL or your partial input file name. The maximum length for an input file is 300 characters.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Optional. Number of jobs, up to twenty, that will be returned at one time.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.order(Order)
/set_order(Option<Order>)
:
required: false
Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.queue(impl Into<String>)
/set_queue(Option<String>)
:
required: false
Optional. Provide a queue name, or a queue ARN, to return only jobs from that queue.status(JobStatus)
/set_status(Option<JobStatus>)
:
required: false
Optional. A job’s status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
- On success, responds with
SearchJobsOutput
with field(s):jobs(Option<Vec::<Job>>)
: List of jobs.next_token(Option<String>)
: Use this string to request the next batch of jobs.
- On failure, responds with
SdkError<SearchJobsError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the resource that you want to tag. To get the ARN, send a GET request with the resource name.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: true
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name.tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: false
The keys of the tags that you want to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_job_template(&self) -> UpdateJobTemplateFluentBuilder
pub fn update_job_template(&self) -> UpdateJobTemplateFluentBuilder
Constructs a fluent builder for the UpdateJobTemplate
operation.
- The fluent builder is configurable:
acceleration_settings(AccelerationSettings)
/set_acceleration_settings(Option<AccelerationSettings>)
:
required: false
Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.category(impl Into<String>)
/set_category(Option<String>)
:
required: false
The new category for the job template, if you are changing it.description(impl Into<String>)
/set_description(Option<String>)
:
required: false
The new description for the job template, if you are changing it.hop_destinations(HopDestination)
/set_hop_destinations(Option<Vec::<HopDestination>>)
:
required: false
Optional list of hop destinations.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the job template you are modifyingpriority(i32)
/set_priority(Option<i32>)
:
required: false
Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don’t specify a priority, the service uses the default value 0.queue(impl Into<String>)
/set_queue(Option<String>)
:
required: false
The new queue for the job template, if you are changing it.settings(JobTemplateSettings)
/set_settings(Option<JobTemplateSettings>)
:
required: false
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.status_update_interval(StatusUpdateInterval)
/set_status_update_interval(Option<StatusUpdateInterval>)
:
required: false
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
- On success, responds with
UpdateJobTemplateOutput
with field(s):job_template(Option<JobTemplate>)
: A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
- On failure, responds with
SdkError<UpdateJobTemplateError>
source§impl Client
impl Client
sourcepub fn update_preset(&self) -> UpdatePresetFluentBuilder
pub fn update_preset(&self) -> UpdatePresetFluentBuilder
Constructs a fluent builder for the UpdatePreset
operation.
- The fluent builder is configurable:
category(impl Into<String>)
/set_category(Option<String>)
:
required: false
The new category for the preset, if you are changing it.description(impl Into<String>)
/set_description(Option<String>)
:
required: false
The new description for the preset, if you are changing it.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the preset you are modifying.settings(PresetSettings)
/set_settings(Option<PresetSettings>)
:
required: false
Settings for preset
- On success, responds with
UpdatePresetOutput
with field(s):preset(Option<Preset>)
: A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
- On failure, responds with
SdkError<UpdatePresetError>
source§impl Client
impl Client
sourcepub fn update_queue(&self) -> UpdateQueueFluentBuilder
pub fn update_queue(&self) -> UpdateQueueFluentBuilder
Constructs a fluent builder for the UpdateQueue
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
The new description for the queue, if you are changing it.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the queue that you are modifying.reservation_plan_settings(ReservationPlanSettings)
/set_reservation_plan_settings(Option<ReservationPlanSettings>)
:
required: false
The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can’t cancel them.status(QueueStatus)
/set_status(Option<QueueStatus>)
:
required: false
Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won’t begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.
- On success, responds with
UpdateQueueOutput
with field(s):queue(Option<Queue>)
: You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don’t specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
- On failure, responds with
SdkError<UpdateQueueError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more