Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.CreateNamespace

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

Synopsis

data CreateNamespace = CreateNamespace' {
- tags :: Maybe (NonEmpty Tag)
- awsAccountId :: Text
- namespace :: Text
- identityStore :: IdentityStore
}
newCreateNamespace :: Text -> Text -> IdentityStore -> CreateNamespace
createNamespace_tags :: Lens' CreateNamespace (Maybe (NonEmpty Tag))
createNamespace_awsAccountId :: Lens' CreateNamespace Text
createNamespace_namespace :: Lens' CreateNamespace Text
createNamespace_identityStore :: Lens' CreateNamespace IdentityStore
data CreateNamespaceResponse = CreateNamespaceResponse' {
- arn :: Maybe Text
- capacityRegion :: Maybe Text
- creationStatus :: Maybe NamespaceStatus
- identityStore :: Maybe IdentityStore
- name :: Maybe Text
- requestId :: Maybe Text
- status :: Int
}
newCreateNamespaceResponse :: Int -> CreateNamespaceResponse
createNamespaceResponse_arn :: Lens' CreateNamespaceResponse (Maybe Text)
createNamespaceResponse_capacityRegion :: Lens' CreateNamespaceResponse (Maybe Text)
createNamespaceResponse_creationStatus :: Lens' CreateNamespaceResponse (Maybe NamespaceStatus)
createNamespaceResponse_identityStore :: Lens' CreateNamespaceResponse (Maybe IdentityStore)
createNamespaceResponse_name :: Lens' CreateNamespaceResponse (Maybe Text)
createNamespaceResponse_requestId :: Lens' CreateNamespaceResponse (Maybe Text)
createNamespaceResponse_status :: Lens' CreateNamespaceResponse Int

Creating a Request

data CreateNamespace Source #

See: newCreateNamespace smart constructor.

Constructors

CreateNamespace'

Fields

tags :: Maybe (NonEmpty Tag)
The tags that you want to associate with the namespace that you're creating.
awsAccountId :: Text
The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.
namespace :: Text
The name that you want to use to describe the new namespace.
identityStore :: IdentityStore
Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

Instances

Instances details

ToJSON CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods toJSON :: CreateNamespace -> Value # toEncoding :: CreateNamespace -> Encoding # toJSONList :: [CreateNamespace] -> Value # toEncodingList :: [CreateNamespace] -> Encoding #
ToHeaders CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods toHeaders :: CreateNamespace -> [Header] #
ToPath CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods toPath :: CreateNamespace -> ByteString #
ToQuery CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods toQuery :: CreateNamespace -> QueryString #
AWSRequest CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Associated Types type AWSResponse CreateNamespace # Methods request :: (Service -> Service) -> CreateNamespace -> Request CreateNamespace # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateNamespace -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateNamespace))) #
Generic CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Associated Types type Rep CreateNamespace :: Type -> Type # Methods from :: CreateNamespace -> Rep CreateNamespace x # to :: Rep CreateNamespace x -> CreateNamespace #
Read CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods readsPrec :: Int -> ReadS CreateNamespace # readList :: ReadS [CreateNamespace] # readPrec :: ReadPrec CreateNamespace # readListPrec :: ReadPrec [CreateNamespace] #
Show CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods showsPrec :: Int -> CreateNamespace -> ShowS # show :: CreateNamespace -> String # showList :: [CreateNamespace] -> ShowS #
NFData CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods rnf :: CreateNamespace -> () #
Eq CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods (==) :: CreateNamespace -> CreateNamespace -> Bool # (/=) :: CreateNamespace -> CreateNamespace -> Bool #
Hashable CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods hashWithSalt :: Int -> CreateNamespace -> Int # hash :: CreateNamespace -> Int #
type AWSResponse CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace type AWSResponse CreateNamespace = CreateNamespaceResponse
type Rep CreateNamespace Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace type Rep CreateNamespace = D1 ('MetaData "CreateNamespace" "Amazonka.QuickSight.CreateNamespace" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateNamespace'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "identityStore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdentityStore))))

newCreateNamespace Source #

Arguments

:: Text	`CreateNamespace`
-> Text	`CreateNamespace`
-> IdentityStore	`CreateNamespace`
-> CreateNamespace

Create a value of CreateNamespace 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:

CreateNamespace, createNamespace_tags - The tags that you want to associate with the namespace that you're creating.

CreateNamespace, createNamespace_awsAccountId - The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

CreateNamespace, createNamespace_namespace - The name that you want to use to describe the new namespace.

CreateNamespace, createNamespace_identityStore - Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

Request Lenses

createNamespace_tags :: Lens' CreateNamespace (Maybe (NonEmpty Tag)) Source #

The tags that you want to associate with the namespace that you're creating.

createNamespace_awsAccountId :: Lens' CreateNamespace Text Source #

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

createNamespace_namespace :: Lens' CreateNamespace Text Source #

The name that you want to use to describe the new namespace.

createNamespace_identityStore :: Lens' CreateNamespace IdentityStore Source #

Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

Destructuring the Response

data CreateNamespaceResponse Source #

See: newCreateNamespaceResponse smart constructor.

Constructors

CreateNamespaceResponse'

Fields

arn :: Maybe Text
The ARN of the Amazon QuickSight namespace you created.
capacityRegion :: Maybe Text
The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.
creationStatus :: Maybe NamespaceStatus
The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.
identityStore :: Maybe IdentityStore
Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
name :: Maybe Text
The name of the new namespace that you created.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
status :: Int
The HTTP status of the request.

Instances

Instances details

Generic CreateNamespaceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Associated Types type Rep CreateNamespaceResponse :: Type -> Type # Methods from :: CreateNamespaceResponse -> Rep CreateNamespaceResponse x # to :: Rep CreateNamespaceResponse x -> CreateNamespaceResponse #
Read CreateNamespaceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods readsPrec :: Int -> ReadS CreateNamespaceResponse # readList :: ReadS [CreateNamespaceResponse] # readPrec :: ReadPrec CreateNamespaceResponse # readListPrec :: ReadPrec [CreateNamespaceResponse] #
Show CreateNamespaceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods showsPrec :: Int -> CreateNamespaceResponse -> ShowS # show :: CreateNamespaceResponse -> String # showList :: [CreateNamespaceResponse] -> ShowS #
NFData CreateNamespaceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods rnf :: CreateNamespaceResponse -> () #
Eq CreateNamespaceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace Methods (==) :: CreateNamespaceResponse -> CreateNamespaceResponse -> Bool # (/=) :: CreateNamespaceResponse -> CreateNamespaceResponse -> Bool #
type Rep CreateNamespaceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateNamespace type Rep CreateNamespaceResponse = D1 ('MetaData "CreateNamespaceResponse" "Amazonka.QuickSight.CreateNamespace" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateNamespaceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "capacityRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NamespaceStatus)))) :: ((S1 ('MetaSel ('Just "identityStore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityStore)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateNamespaceResponse Source #

Arguments

:: Int	`CreateNamespaceResponse`
-> CreateNamespaceResponse

Create a value of CreateNamespaceResponse 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:

CreateNamespaceResponse, createNamespaceResponse_arn - The ARN of the Amazon QuickSight namespace you created.

CreateNamespaceResponse, createNamespaceResponse_capacityRegion - The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.

CreateNamespaceResponse, createNamespaceResponse_creationStatus - The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.

CreateNamespace, createNamespaceResponse_identityStore - Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

CreateNamespaceResponse, createNamespaceResponse_name - The name of the new namespace that you created.

$sel:requestId:CreateNamespaceResponse', createNamespaceResponse_requestId - The Amazon Web Services request ID for this operation.

CreateNamespaceResponse, createNamespaceResponse_status - The HTTP status of the request.

Response Lenses

createNamespaceResponse_arn :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The ARN of the Amazon QuickSight namespace you created.

createNamespaceResponse_capacityRegion :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.

createNamespaceResponse_creationStatus :: Lens' CreateNamespaceResponse (Maybe NamespaceStatus) Source #

The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.

createNamespaceResponse_identityStore :: Lens' CreateNamespaceResponse (Maybe IdentityStore) Source #

Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

createNamespaceResponse_name :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The name of the new namespace that you created.

createNamespaceResponse_requestId :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createNamespaceResponse_status :: Lens' CreateNamespaceResponse Int Source #

The HTTP status of the request.