Packages
aws
1.0.11
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.12
0.0.11
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
AWS clients for Elixir
Current section
Files
Jump to
Current section
Files
lib/aws/generated/media_package.ex
# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.MediaPackage do
@moduledoc """
AWS Elemental MediaPackage
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
rotate_ingest_endpoint_credentials_request() :: %{}
"""
@type rotate_ingest_endpoint_credentials_request() :: %{}
@typedoc """
## Example:
delete_channel_request() :: %{}
"""
@type delete_channel_request() :: %{}
@typedoc """
## Example:
tag_resource_request() :: %{
required("Tags") => map()
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
hls_manifest_create_or_update_parameters() :: %{
"AdMarkers" => list(any()),
"AdTriggers" => list(list(any())()),
"AdsOnDeliveryRestrictions" => list(any()),
"Id" => String.t() | atom(),
"IncludeIframeOnlyStream" => boolean(),
"ManifestName" => String.t() | atom(),
"PlaylistType" => list(any()),
"PlaylistWindowSeconds" => integer(),
"ProgramDateTimeIntervalSeconds" => integer()
}
"""
@type hls_manifest_create_or_update_parameters() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_origin_endpoint_request() :: %{
optional("Authorization") => authorization(),
optional("CmafPackage") => cmaf_package_create_or_update_parameters(),
optional("DashPackage") => dash_package(),
optional("Description") => String.t() | atom(),
optional("HlsPackage") => hls_package(),
optional("ManifestName") => String.t() | atom(),
optional("MssPackage") => mss_package(),
optional("Origination") => list(any()),
optional("StartoverWindowSeconds") => integer(),
optional("Tags") => map(),
optional("TimeDelaySeconds") => integer(),
optional("Whitelist") => list(String.t() | atom()),
required("ChannelId") => String.t() | atom(),
required("Id") => String.t() | atom()
}
"""
@type create_origin_endpoint_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_response() :: %{
"Arn" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"Description" => String.t() | atom(),
"EgressAccessLogs" => egress_access_logs(),
"HlsIngest" => hls_ingest(),
"Id" => String.t() | atom(),
"IngressAccessLogs" => ingress_access_logs(),
"Tags" => map()
}
"""
@type create_channel_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_channel_response() :: %{}
"""
@type delete_channel_response() :: %{}
@typedoc """
## Example:
create_origin_endpoint_response() :: %{
"Arn" => String.t() | atom(),
"Authorization" => authorization(),
"ChannelId" => String.t() | atom(),
"CmafPackage" => cmaf_package(),
"CreatedAt" => String.t() | atom(),
"DashPackage" => dash_package(),
"Description" => String.t() | atom(),
"HlsPackage" => hls_package(),
"Id" => String.t() | atom(),
"ManifestName" => String.t() | atom(),
"MssPackage" => mss_package(),
"Origination" => list(any()),
"StartoverWindowSeconds" => integer(),
"Tags" => map(),
"TimeDelaySeconds" => integer(),
"Url" => String.t() | atom(),
"Whitelist" => list(String.t() | atom())
}
"""
@type create_origin_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rotate_channel_credentials_response() :: %{
"Arn" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"Description" => String.t() | atom(),
"EgressAccessLogs" => egress_access_logs(),
"HlsIngest" => hls_ingest(),
"Id" => String.t() | atom(),
"IngressAccessLogs" => ingress_access_logs(),
"Tags" => map()
}
"""
@type rotate_channel_credentials_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
forbidden_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type forbidden_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_origin_endpoint_request() :: %{
optional("Authorization") => authorization(),
optional("CmafPackage") => cmaf_package_create_or_update_parameters(),
optional("DashPackage") => dash_package(),
optional("Description") => String.t() | atom(),
optional("HlsPackage") => hls_package(),
optional("ManifestName") => String.t() | atom(),
optional("MssPackage") => mss_package(),
optional("Origination") => list(any()),
optional("StartoverWindowSeconds") => integer(),
optional("TimeDelaySeconds") => integer(),
optional("Whitelist") => list(String.t() | atom())
}
"""
@type update_origin_endpoint_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
origin_endpoint() :: %{
"Arn" => String.t() | atom(),
"Authorization" => authorization(),
"ChannelId" => String.t() | atom(),
"CmafPackage" => cmaf_package(),
"CreatedAt" => String.t() | atom(),
"DashPackage" => dash_package(),
"Description" => String.t() | atom(),
"HlsPackage" => hls_package(),
"Id" => String.t() | atom(),
"ManifestName" => String.t() | atom(),
"MssPackage" => mss_package(),
"Origination" => list(any()),
"StartoverWindowSeconds" => integer(),
"Tags" => map(),
"TimeDelaySeconds" => integer(),
"Url" => String.t() | atom(),
"Whitelist" => list(String.t() | atom())
}
"""
@type origin_endpoint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_harvest_jobs_request() :: %{
optional("IncludeChannelId") => String.t() | atom(),
optional("IncludeStatus") => String.t() | atom(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_harvest_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_origin_endpoint_response() :: %{}
"""
@type delete_origin_endpoint_response() :: %{}
@typedoc """
## Example:
rotate_channel_credentials_request() :: %{}
"""
@type rotate_channel_credentials_request() :: %{}
@typedoc """
## Example:
delete_origin_endpoint_request() :: %{}
"""
@type delete_origin_endpoint_request() :: %{}
@typedoc """
## Example:
describe_origin_endpoint_response() :: %{
"Arn" => String.t() | atom(),
"Authorization" => authorization(),
"ChannelId" => String.t() | atom(),
"CmafPackage" => cmaf_package(),
"CreatedAt" => String.t() | atom(),
"DashPackage" => dash_package(),
"Description" => String.t() | atom(),
"HlsPackage" => hls_package(),
"Id" => String.t() | atom(),
"ManifestName" => String.t() | atom(),
"MssPackage" => mss_package(),
"Origination" => list(any()),
"StartoverWindowSeconds" => integer(),
"Tags" => map(),
"TimeDelaySeconds" => integer(),
"Url" => String.t() | atom(),
"Whitelist" => list(String.t() | atom())
}
"""
@type describe_origin_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rotate_ingest_endpoint_credentials_response() :: %{
"Arn" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"Description" => String.t() | atom(),
"EgressAccessLogs" => egress_access_logs(),
"HlsIngest" => hls_ingest(),
"Id" => String.t() | atom(),
"IngressAccessLogs" => ingress_access_logs(),
"Tags" => map()
}
"""
@type rotate_ingest_endpoint_credentials_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("TagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
too_many_requests_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type too_many_requests_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
hls_manifest() :: %{
"AdMarkers" => list(any()),
"AdTriggers" => list(list(any())()),
"AdsOnDeliveryRestrictions" => list(any()),
"Id" => String.t() | atom(),
"IncludeIframeOnlyStream" => boolean(),
"ManifestName" => String.t() | atom(),
"PlaylistType" => list(any()),
"PlaylistWindowSeconds" => integer(),
"ProgramDateTimeIntervalSeconds" => integer(),
"Url" => String.t() | atom()
}
"""
@type hls_manifest() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
hls_ingest() :: %{
"IngestEndpoints" => list(ingest_endpoint())
}
"""
@type hls_ingest() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_harvest_job_request() :: %{}
"""
@type describe_harvest_job_request() :: %{}
@typedoc """
## Example:
list_origin_endpoints_response() :: %{
"NextToken" => String.t() | atom(),
"OriginEndpoints" => list(origin_endpoint())
}
"""
@type list_origin_endpoints_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
authorization() :: %{
"CdnIdentifierSecret" => String.t() | atom(),
"SecretsRoleArn" => String.t() | atom()
}
"""
@type authorization() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_harvest_job_request() :: %{
required("EndTime") => String.t() | atom(),
required("Id") => String.t() | atom(),
required("OriginEndpointId") => String.t() | atom(),
required("S3Destination") => s3_destination(),
required("StartTime") => String.t() | atom()
}
"""
@type create_harvest_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
hls_encryption() :: %{
"ConstantInitializationVector" => String.t() | atom(),
"EncryptionMethod" => list(any()),
"KeyRotationIntervalSeconds" => integer(),
"RepeatExtXKey" => boolean(),
"SpekeKeyProvider" => speke_key_provider()
}
"""
@type hls_encryption() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cmaf_package() :: %{
"Encryption" => cmaf_encryption(),
"HlsManifests" => list(hls_manifest()),
"SegmentDurationSeconds" => integer(),
"SegmentPrefix" => String.t() | atom(),
"StreamSelection" => stream_selection()
}
"""
@type cmaf_package() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_response() :: %{
"Arn" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"Description" => String.t() | atom(),
"EgressAccessLogs" => egress_access_logs(),
"HlsIngest" => hls_ingest(),
"Id" => String.t() | atom(),
"IngressAccessLogs" => ingress_access_logs(),
"Tags" => map()
}
"""
@type describe_channel_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cmaf_package_create_or_update_parameters() :: %{
"Encryption" => cmaf_encryption(),
"HlsManifests" => list(hls_manifest_create_or_update_parameters()),
"SegmentDurationSeconds" => integer(),
"SegmentPrefix" => String.t() | atom(),
"StreamSelection" => stream_selection()
}
"""
@type cmaf_package_create_or_update_parameters() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
not_found_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_request() :: %{}
"""
@type describe_channel_request() :: %{}
@typedoc """
## Example:
speke_key_provider() :: %{
"CertificateArn" => String.t() | atom(),
"EncryptionContractConfiguration" => encryption_contract_configuration(),
"ResourceId" => String.t() | atom(),
"RoleArn" => String.t() | atom(),
"SystemIds" => list(String.t() | atom()),
"Url" => String.t() | atom()
}
"""
@type speke_key_provider() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ingest_endpoint() :: %{
"Id" => String.t() | atom(),
"Password" => String.t() | atom(),
"Url" => String.t() | atom(),
"Username" => String.t() | atom()
}
"""
@type ingest_endpoint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_request() :: %{
optional("Description") => String.t() | atom(),
optional("Tags") => map(),
required("Id") => String.t() | atom()
}
"""
@type create_channel_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"Tags" => map()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
hls_package() :: %{
"AdMarkers" => list(any()),
"AdTriggers" => list(list(any())()),
"AdsOnDeliveryRestrictions" => list(any()),
"Encryption" => hls_encryption(),
"IncludeDvbSubtitles" => boolean(),
"IncludeIframeOnlyStream" => boolean(),
"PlaylistType" => list(any()),
"PlaylistWindowSeconds" => integer(),
"ProgramDateTimeIntervalSeconds" => integer(),
"SegmentDurationSeconds" => integer(),
"StreamSelection" => stream_selection(),
"UseAudioRenditionGroup" => boolean()
}
"""
@type hls_package() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_unavailable_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type service_unavailable_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dash_package() :: %{
"AdTriggers" => list(list(any())()),
"AdsOnDeliveryRestrictions" => list(any()),
"Encryption" => dash_encryption(),
"IncludeIframeOnlyStream" => boolean(),
"ManifestLayout" => list(any()),
"ManifestWindowSeconds" => integer(),
"MinBufferTimeSeconds" => integer(),
"MinUpdatePeriodSeconds" => integer(),
"PeriodTriggers" => list(list(any())()),
"Profile" => list(any()),
"SegmentDurationSeconds" => integer(),
"SegmentTemplateFormat" => list(any()),
"StreamSelection" => stream_selection(),
"SuggestedPresentationDelaySeconds" => integer(),
"UtcTiming" => list(any()),
"UtcTimingUri" => String.t() | atom()
}
"""
@type dash_package() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channels_response() :: %{
"Channels" => list(channel()),
"NextToken" => String.t() | atom()
}
"""
@type list_channels_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_destination() :: %{
"BucketName" => String.t() | atom(),
"ManifestKey" => String.t() | atom(),
"RoleArn" => String.t() | atom()
}
"""
@type s3_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_request() :: %{
optional("Description") => String.t() | atom()
}
"""
@type update_channel_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stream_selection() :: %{
"MaxVideoBitsPerSecond" => integer(),
"MinVideoBitsPerSecond" => integer(),
"StreamOrder" => list(any())
}
"""
@type stream_selection() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
encryption_contract_configuration() :: %{
"PresetSpeke20Audio" => list(any()),
"PresetSpeke20Video" => list(any())
}
"""
@type encryption_contract_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
egress_access_logs() :: %{
"LogGroupName" => String.t() | atom()
}
"""
@type egress_access_logs() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dash_encryption() :: %{
"KeyRotationIntervalSeconds" => integer(),
"SpekeKeyProvider" => speke_key_provider()
}
"""
@type dash_encryption() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
unprocessable_entity_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type unprocessable_entity_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cmaf_encryption() :: %{
"ConstantInitializationVector" => String.t() | atom(),
"EncryptionMethod" => list(any()),
"KeyRotationIntervalSeconds" => integer(),
"SpekeKeyProvider" => speke_key_provider()
}
"""
@type cmaf_encryption() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
internal_server_error_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type internal_server_error_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel() :: %{
"Arn" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"Description" => String.t() | atom(),
"EgressAccessLogs" => egress_access_logs(),
"HlsIngest" => hls_ingest(),
"Id" => String.t() | atom(),
"IngressAccessLogs" => ingress_access_logs(),
"Tags" => map()
}
"""
@type channel() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
harvest_job() :: %{
"Arn" => String.t() | atom(),
"ChannelId" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"EndTime" => String.t() | atom(),
"Id" => String.t() | atom(),
"OriginEndpointId" => String.t() | atom(),
"S3Destination" => s3_destination(),
"StartTime" => String.t() | atom(),
"Status" => list(any())
}
"""
@type harvest_job() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_harvest_job_response() :: %{
"Arn" => String.t() | atom(),
"ChannelId" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"EndTime" => String.t() | atom(),
"Id" => String.t() | atom(),
"OriginEndpointId" => String.t() | atom(),
"S3Destination" => s3_destination(),
"StartTime" => String.t() | atom(),
"Status" => list(any())
}
"""
@type describe_harvest_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_harvest_job_response() :: %{
"Arn" => String.t() | atom(),
"ChannelId" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"EndTime" => String.t() | atom(),
"Id" => String.t() | atom(),
"OriginEndpointId" => String.t() | atom(),
"S3Destination" => s3_destination(),
"StartTime" => String.t() | atom(),
"Status" => list(any())
}
"""
@type create_harvest_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
configure_logs_response() :: %{
"Arn" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"Description" => String.t() | atom(),
"EgressAccessLogs" => egress_access_logs(),
"HlsIngest" => hls_ingest(),
"Id" => String.t() | atom(),
"IngressAccessLogs" => ingress_access_logs(),
"Tags" => map()
}
"""
@type configure_logs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_origin_endpoint_request() :: %{}
"""
@type describe_origin_endpoint_request() :: %{}
@typedoc """
## Example:
configure_logs_request() :: %{
optional("EgressAccessLogs") => egress_access_logs(),
optional("IngressAccessLogs") => ingress_access_logs()
}
"""
@type configure_logs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_harvest_jobs_response() :: %{
"HarvestJobs" => list(harvest_job()),
"NextToken" => String.t() | atom()
}
"""
@type list_harvest_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_response() :: %{
"Arn" => String.t() | atom(),
"CreatedAt" => String.t() | atom(),
"Description" => String.t() | atom(),
"EgressAccessLogs" => egress_access_logs(),
"HlsIngest" => hls_ingest(),
"Id" => String.t() | atom(),
"IngressAccessLogs" => ingress_access_logs(),
"Tags" => map()
}
"""
@type update_channel_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
mss_encryption() :: %{
"SpekeKeyProvider" => speke_key_provider()
}
"""
@type mss_encryption() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_origin_endpoint_response() :: %{
"Arn" => String.t() | atom(),
"Authorization" => authorization(),
"ChannelId" => String.t() | atom(),
"CmafPackage" => cmaf_package(),
"CreatedAt" => String.t() | atom(),
"DashPackage" => dash_package(),
"Description" => String.t() | atom(),
"HlsPackage" => hls_package(),
"Id" => String.t() | atom(),
"ManifestName" => String.t() | atom(),
"MssPackage" => mss_package(),
"Origination" => list(any()),
"StartoverWindowSeconds" => integer(),
"Tags" => map(),
"TimeDelaySeconds" => integer(),
"Url" => String.t() | atom(),
"Whitelist" => list(String.t() | atom())
}
"""
@type update_origin_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channels_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_channels_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_origin_endpoints_request() :: %{
optional("ChannelId") => String.t() | atom(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_origin_endpoints_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ingress_access_logs() :: %{
"LogGroupName" => String.t() | atom()
}
"""
@type ingress_access_logs() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
mss_package() :: %{
"Encryption" => mss_encryption(),
"ManifestWindowSeconds" => integer(),
"SegmentDurationSeconds" => integer(),
"StreamSelection" => stream_selection()
}
"""
@type mss_package() :: %{(String.t() | atom()) => any()}
@type configure_logs_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type create_channel_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type create_harvest_job_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type create_origin_endpoint_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type delete_channel_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type delete_origin_endpoint_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type describe_channel_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type describe_harvest_job_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type describe_origin_endpoint_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type list_channels_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type list_harvest_jobs_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type list_origin_endpoints_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type rotate_channel_credentials_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type rotate_ingest_endpoint_credentials_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type update_channel_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
@type update_origin_endpoint_errors() ::
internal_server_error_exception()
| unprocessable_entity_exception()
| service_unavailable_exception()
| not_found_exception()
| too_many_requests_exception()
| forbidden_exception()
def metadata do
%{
api_version: "2017-10-12",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "mediapackage",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "MediaPackage",
signature_version: "v4",
signing_name: "mediapackage",
target_prefix: nil
}
end
@doc """
Changes the Channel's properities to configure log subscription
"""
@spec configure_logs(map(), String.t() | atom(), configure_logs_request(), list()) ::
{:ok, configure_logs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, configure_logs_errors()}
def configure_logs(%Client{} = client, id, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(id)}/configure_logs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new Channel.
"""
@spec create_channel(map(), create_channel_request(), list()) ::
{:ok, create_channel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_channel_errors()}
def create_channel(%Client{} = client, input, options \\ []) do
url_path = "/channels"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new HarvestJob record.
"""
@spec create_harvest_job(map(), create_harvest_job_request(), list()) ::
{:ok, create_harvest_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_harvest_job_errors()}
def create_harvest_job(%Client{} = client, input, options \\ []) do
url_path = "/harvest_jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new OriginEndpoint record.
"""
@spec create_origin_endpoint(map(), create_origin_endpoint_request(), list()) ::
{:ok, create_origin_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_origin_endpoint_errors()}
def create_origin_endpoint(%Client{} = client, input, options \\ []) do
url_path = "/origin_endpoints"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an existing Channel.
"""
@spec delete_channel(map(), String.t() | atom(), delete_channel_request(), list()) ::
{:ok, delete_channel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_channel_errors()}
def delete_channel(%Client{} = client, id, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Deletes an existing OriginEndpoint.
"""
@spec delete_origin_endpoint(
map(),
String.t() | atom(),
delete_origin_endpoint_request(),
list()
) ::
{:ok, delete_origin_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_origin_endpoint_errors()}
def delete_origin_endpoint(%Client{} = client, id, input, options \\ []) do
url_path = "/origin_endpoints/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Gets details about a Channel.
"""
@spec describe_channel(map(), String.t() | atom(), list()) ::
{:ok, describe_channel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_channel_errors()}
def describe_channel(%Client{} = client, id, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about an existing HarvestJob.
"""
@spec describe_harvest_job(map(), String.t() | atom(), list()) ::
{:ok, describe_harvest_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_harvest_job_errors()}
def describe_harvest_job(%Client{} = client, id, options \\ []) do
url_path = "/harvest_jobs/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about an existing OriginEndpoint.
"""
@spec describe_origin_endpoint(map(), String.t() | atom(), list()) ::
{:ok, describe_origin_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_origin_endpoint_errors()}
def describe_origin_endpoint(%Client{} = client, id, options \\ []) do
url_path = "/origin_endpoints/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a collection of Channels.
"""
@spec list_channels(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_channels_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channels_errors()}
def list_channels(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/channels"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a collection of HarvestJob records.
"""
@spec list_harvest_jobs(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_harvest_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_harvest_jobs_errors()}
def list_harvest_jobs(
%Client{} = client,
include_channel_id \\ nil,
include_status \\ nil,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/harvest_jobs"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(include_status) do
[{"includeStatus", include_status} | query_params]
else
query_params
end
query_params =
if !is_nil(include_channel_id) do
[{"includeChannelId", include_channel_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a collection of OriginEndpoint records.
"""
@spec list_origin_endpoints(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_origin_endpoints_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_origin_endpoints_errors()}
def list_origin_endpoints(
%Client{} = client,
channel_id \\ nil,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/origin_endpoints"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(channel_id) do
[{"channelId", channel_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Changes the Channel's first IngestEndpoint's username and password.
WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials
instead
"""
@spec rotate_channel_credentials(
map(),
String.t() | atom(),
rotate_channel_credentials_request(),
list()
) ::
{:ok, rotate_channel_credentials_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, rotate_channel_credentials_errors()}
def rotate_channel_credentials(%Client{} = client, id, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(id)}/credentials"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Rotate the IngestEndpoint's username and password, as specified by the
IngestEndpoint's id.
"""
@spec rotate_ingest_endpoint_credentials(
map(),
String.t() | atom(),
String.t() | atom(),
rotate_ingest_endpoint_credentials_request(),
list()
) ::
{:ok, rotate_ingest_endpoint_credentials_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, rotate_ingest_endpoint_credentials_errors()}
def rotate_ingest_endpoint_credentials(
%Client{} = client,
id,
ingest_endpoint_id,
input,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(id)}/ingest_endpoints/#{AWS.Util.encode_uri(ingest_endpoint_id)}/credentials"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"TagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Updates an existing Channel.
"""
@spec update_channel(map(), String.t() | atom(), update_channel_request(), list()) ::
{:ok, update_channel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_channel_errors()}
def update_channel(%Client{} = client, id, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing OriginEndpoint.
"""
@spec update_origin_endpoint(
map(),
String.t() | atom(),
update_origin_endpoint_request(),
list()
) ::
{:ok, update_origin_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_origin_endpoint_errors()}
def update_origin_endpoint(%Client{} = client, id, input, options \\ []) do
url_path = "/origin_endpoints/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end