libZSservicesZSamazonka-mediastoreZSamazonka-mediastore
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaStore.CreateContainer

Description

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

Synopsis

Creating a Request

data CreateContainer Source #

See: newCreateContainer smart constructor.

Constructors

CreateContainer' 

Fields

  • tags :: Maybe (NonEmpty Tag)

    An array of key:value pairs that you define. These values can be anything that you want. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). 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.

  • containerName :: Text

    The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

Instances

Instances details
Eq CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Read CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Show CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Generic CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Associated Types

type Rep CreateContainer :: Type -> Type #

NFData CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Methods

rnf :: CreateContainer -> () #

Hashable CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

ToJSON CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

AWSRequest CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Associated Types

type AWSResponse CreateContainer #

ToHeaders CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

ToPath CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

ToQuery CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

type Rep CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

type Rep CreateContainer = D1 ('MetaData "CreateContainer" "Amazonka.MediaStore.CreateContainer" "libZSservicesZSamazonka-mediastoreZSamazonka-mediastore" 'False) (C1 ('MetaCons "CreateContainer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateContainer Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

newCreateContainer Source #

Create a value of CreateContainer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tags:CreateContainer', createContainer_tags - An array of key:value pairs that you define. These values can be anything that you want. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). 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.

$sel:containerName:CreateContainer', createContainer_containerName - The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

Request Lenses

createContainer_tags :: Lens' CreateContainer (Maybe (NonEmpty Tag)) Source #

An array of key:value pairs that you define. These values can be anything that you want. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). 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.

createContainer_containerName :: Lens' CreateContainer Text Source #

The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

Destructuring the Response

data CreateContainerResponse Source #

See: newCreateContainerResponse smart constructor.

Constructors

CreateContainerResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • container :: Container

    ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:<region>:<account that owns this container>:container/<name of container>. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

    ContainerName: The container name as specified in the request.

    CreationTime: Unix time stamp.

    Status: The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When an endpoint is available, the status changes to ACTIVE.

    The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using DescribeContainer or ListContainers.

Instances

Instances details
Eq CreateContainerResponse Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Read CreateContainerResponse Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Show CreateContainerResponse Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Generic CreateContainerResponse Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Associated Types

type Rep CreateContainerResponse :: Type -> Type #

NFData CreateContainerResponse Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

Methods

rnf :: CreateContainerResponse -> () #

type Rep CreateContainerResponse Source # 
Instance details

Defined in Amazonka.MediaStore.CreateContainer

type Rep CreateContainerResponse = D1 ('MetaData "CreateContainerResponse" "Amazonka.MediaStore.CreateContainer" "libZSservicesZSamazonka-mediastoreZSamazonka-mediastore" 'False) (C1 ('MetaCons "CreateContainerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "container") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Container)))

newCreateContainerResponse Source #

Create a value of CreateContainerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateContainerResponse', createContainerResponse_httpStatus - The response's http status code.

$sel:container:CreateContainerResponse', createContainerResponse_container - ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:<region>:<account that owns this container>:container/<name of container>. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

ContainerName: The container name as specified in the request.

CreationTime: Unix time stamp.

Status: The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When an endpoint is available, the status changes to ACTIVE.

The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using DescribeContainer or ListContainers.

Response Lenses

createContainerResponse_container :: Lens' CreateContainerResponse Container Source #

ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:<region>:<account that owns this container>:container/<name of container>. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

ContainerName: The container name as specified in the request.

CreationTime: Unix time stamp.

Status: The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When an endpoint is available, the status changes to ACTIVE.

The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using DescribeContainer or ListContainers.