Class: Aws::MediaStore::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MediaStore::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb
Overview
An API client for MediaStore. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MediaStore::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_container(params = {}) ⇒ Types::CreateContainerOutput
Creates a storage container to hold objects.
-
#delete_container(params = {}) ⇒ Struct
Deletes the specified container.
-
#delete_container_policy(params = {}) ⇒ Struct
Deletes the access policy that is associated with the specified container.
-
#delete_cors_policy(params = {}) ⇒ Struct
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
-
#delete_lifecycle_policy(params = {}) ⇒ Struct
Removes an object lifecycle policy from a container.
-
#delete_metric_policy(params = {}) ⇒ Struct
Deletes the metric policy that is associated with the specified container.
-
#describe_container(params = {}) ⇒ Types::DescribeContainerOutput
Retrieves the properties of the requested container.
-
#get_container_policy(params = {}) ⇒ Types::GetContainerPolicyOutput
Retrieves the access policy for the specified container.
-
#get_cors_policy(params = {}) ⇒ Types::GetCorsPolicyOutput
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
-
#get_lifecycle_policy(params = {}) ⇒ Types::GetLifecyclePolicyOutput
Retrieves the object lifecycle policy that is assigned to a container.
-
#get_metric_policy(params = {}) ⇒ Types::GetMetricPolicyOutput
Returns the metric policy for the specified container.
-
#list_containers(params = {}) ⇒ Types::ListContainersOutput
Lists the properties of all containers in AWS Elemental MediaStore.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns a list of the tags assigned to the specified container.
-
#put_container_policy(params = {}) ⇒ Struct
Creates an access policy for the specified container to restrict the users and clients that can access it.
-
#put_cors_policy(params = {}) ⇒ Struct
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.
-
#put_lifecycle_policy(params = {}) ⇒ Struct
Writes an object lifecycle policy to a container.
-
#put_metric_policy(params = {}) ⇒ Struct
The metric policy that you want to add to the container.
-
#start_access_logging(params = {}) ⇒ Struct
Starts access logging on the specified container.
-
#stop_access_logging(params = {}) ⇒ Struct
Stops access logging on the specified container.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified AWS Elemental MediaStore container.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified container.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 429 def initialize(*args) super end |
Instance Method Details
#create_container(params = {}) ⇒ Types::CreateContainerOutput
Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.
487 488 489 490 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 487 def create_container(params = {}, = {}) req = build_request(:create_container, params) req.send_request() end |
#delete_container(params = {}) ⇒ Struct
Deletes the specified container. Before you make a DeleteContainer
request, delete any objects in the container or in any folders in the
container. You can delete only empty containers.
511 512 513 514 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 511 def delete_container(params = {}, = {}) req = build_request(:delete_container, params) req.send_request() end |
#delete_container_policy(params = {}) ⇒ Struct
Deletes the access policy that is associated with the specified container.
534 535 536 537 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 534 def delete_container_policy(params = {}, = {}) req = build_request(:delete_container_policy, params) req.send_request() end |
#delete_cors_policy(params = {}) ⇒ Struct
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
To use this operation, you must have permission to perform the
MediaStore:DeleteCorsPolicy
action. The container owner has this
permission by default and can grant this permission to others.
561 562 563 564 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 561 def delete_cors_policy(params = {}, = {}) req = build_request(:delete_cors_policy, params) req.send_request() end |
#delete_lifecycle_policy(params = {}) ⇒ Struct
Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.
584 585 586 587 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 584 def delete_lifecycle_policy(params = {}, = {}) req = build_request(:delete_lifecycle_policy, params) req.send_request() end |
#delete_metric_policy(params = {}) ⇒ Struct
Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch.
609 610 611 612 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 609 def delete_metric_policy(params = {}, = {}) req = build_request(:delete_metric_policy, params) req.send_request() end |
#describe_container(params = {}) ⇒ Types::DescribeContainerOutput
Retrieves the properties of the requested container. This request is
commonly used to retrieve the endpoint of a container. An endpoint is
a value assigned by the service when a new container is created. A
container's endpoint does not change after it has been assigned. The
DescribeContainer
request returns a single Container
object based
on ContainerName
. To return all Container
objects that are
associated with a specified AWS account, use ListContainers.
648 649 650 651 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 648 def describe_container(params = {}, = {}) req = build_request(:describe_container, params) req.send_request() end |
#get_container_policy(params = {}) ⇒ Types::GetContainerPolicyOutput
Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
682 683 684 685 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 682 def get_container_policy(params = {}, = {}) req = build_request(:get_container_policy, params) req.send_request() end |
#get_cors_policy(params = {}) ⇒ Types::GetCorsPolicyOutput
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
To use this operation, you must have permission to perform the
MediaStore:GetCorsPolicy
action. By default, the container owner has
this permission and can grant it to others.
724 725 726 727 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 724 def get_cors_policy(params = {}, = {}) req = build_request(:get_cors_policy, params) req.send_request() end |
#get_lifecycle_policy(params = {}) ⇒ Types::GetLifecyclePolicyOutput
Retrieves the object lifecycle policy that is assigned to a container.
753 754 755 756 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 753 def get_lifecycle_policy(params = {}, = {}) req = build_request(:get_lifecycle_policy, params) req.send_request() end |
#get_metric_policy(params = {}) ⇒ Types::GetMetricPolicyOutput
Returns the metric policy for the specified container.
784 785 786 787 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 784 def get_metric_policy(params = {}, = {}) req = build_request(:get_metric_policy, params) req.send_request() end |
#list_containers(params = {}) ⇒ Types::ListContainersOutput
Lists the properties of all containers in AWS Elemental MediaStore.
You can query to receive all the containers in one response. Or you
can include the MaxResults
parameter to receive a limited number of
containers in each response. In this case, the response includes a
token. To get the next set of containers, send the command again, this
time with the NextToken
parameter (with the returned token as its
value). The next set of responses appears, with a token if there are
still more containers to receive.
See also DescribeContainer, which gets the properties of one container.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
841 842 843 844 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 841 def list_containers(params = {}, = {}) req = build_request(:list_containers, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns a list of the tags assigned to the specified container.
871 872 873 874 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 871 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_container_policy(params = {}) ⇒ Struct
Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
For this release of the REST API, you can create only one policy for a
container. If you enter PutContainerPolicy
twice, the second command
modifies the existing policy.
912 913 914 915 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 912 def put_container_policy(params = {}, = {}) req = build_request(:put_container_policy, params) req.send_request() end |
#put_cors_policy(params = {}) ⇒ Struct
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.
To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.
To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore.
965 966 967 968 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 965 def put_cors_policy(params = {}, = {}) req = build_request(:put_cors_policy, params) req.send_request() end |
#put_lifecycle_policy(params = {}) ⇒ Struct
Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.
For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 1002 def put_lifecycle_policy(params = {}, = {}) req = build_request(:put_lifecycle_policy, params) req.send_request() end |
#put_metric_policy(params = {}) ⇒ Struct
The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 1055 def put_metric_policy(params = {}, = {}) req = build_request(:put_metric_policy, params) req.send_request() end |
#start_access_logging(params = {}) ⇒ Struct
Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 1079 def start_access_logging(params = {}, = {}) req = build_request(:start_access_logging, params) req.send_request() end |
#stop_access_logging(params = {}) ⇒ Struct
Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable.
1104 1105 1106 1107 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 1104 def stop_access_logging(params = {}, = {}) req = build_request(:stop_access_logging, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.
1152 1153 1154 1155 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 1152 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified container. You can specify one or more tags to remove.
1183 1184 1185 1186 |
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/client.rb', line 1183 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |