MediaStoreClient Class

Member Function Documentation

MediaStoreClient::MediaStoreClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a MediaStoreClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

MediaStoreClient::MediaStoreClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads MediaStoreClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CreateContainerResponse *MediaStoreClient::createContainer(const CreateContainerRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an CreateContainerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3

[slot] DeleteContainerResponse *MediaStoreClient::deleteContainer(const DeleteContainerRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an DeleteContainerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified container. Before you make a <code>DeleteContainer</code> request, delete any objects in the container or in any folders in the container. You can delete only empty containers.

[slot] DeleteContainerPolicyResponse *MediaStoreClient::deleteContainerPolicy(const DeleteContainerPolicyRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an DeleteContainerPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the access policy that is associated with the specified

[slot] DeleteCorsPolicyResponse *MediaStoreClient::deleteCorsPolicy(const DeleteCorsPolicyRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an DeleteCorsPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>MediaStore:DeleteCorsPolicy</code> action. The container owner has this permission by default and can grant this permission to

[slot] DescribeContainerResponse *MediaStoreClient::describeContainer(const DescribeContainerRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an DescribeContainerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>DescribeContainer</code> request returns a single <code>Container</code> object based on <code>ContainerName</code>. To return all <code>Container</code> objects that are associated with a specified AWS account, use

[slot] GetContainerPolicyResponse *MediaStoreClient::getContainerPolicy(const GetContainerPolicyRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an GetContainerPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the <a href="https://aws.amazon.com/documentation/iam/">AWS Identity and Access Management User

[slot] GetCorsPolicyResponse *MediaStoreClient::getCorsPolicy(const GetCorsPolicyRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an GetCorsPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>MediaStore:GetCorsPolicy</code> action. By default, the container owner has this permission and can grant it to

[slot] ListContainersResponse *MediaStoreClient::listContainers(const ListContainersRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an ListContainersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the properties of all containers in AWS Elemental MediaStore.

</p

You can query to receive all the containers in one response. Or you can include the <code>MaxResults</code> 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 <code>NextToken</code> 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.

</p

See also <a>DescribeContainer</a>, which gets the properties of one container.

[slot] PutContainerPolicyResponse *MediaStoreClient::putContainerPolicy(const PutContainerPolicyRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an PutContainerPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="https://aws.amazon.com/documentation/iam/">AWS Identity and Access Management User

Guide</a>>

For this release of the REST API, you can create only one policy for a container. If you enter <code>PutContainerPolicy</code> twice, the second command modifies the existing policy.

[slot] PutCorsPolicyResponse *MediaStoreClient::putCorsPolicy(const PutCorsPolicyRequest &request)

Sends request to the MediaStoreClient service, and returns a pointer to an PutCorsPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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