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.CreateIngestion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.

Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

Synopsis

data CreateIngestion = CreateIngestion' {
- ingestionType :: Maybe IngestionType
- dataSetId :: Text
- ingestionId :: Text
- awsAccountId :: Text
}
newCreateIngestion :: Text -> Text -> Text -> CreateIngestion
createIngestion_ingestionType :: Lens' CreateIngestion (Maybe IngestionType)
createIngestion_dataSetId :: Lens' CreateIngestion Text
createIngestion_ingestionId :: Lens' CreateIngestion Text
createIngestion_awsAccountId :: Lens' CreateIngestion Text
data CreateIngestionResponse = CreateIngestionResponse' {
- arn :: Maybe Text
- ingestionId :: Maybe Text
- ingestionStatus :: Maybe IngestionStatus
- requestId :: Maybe Text
- status :: Int
}
newCreateIngestionResponse :: Int -> CreateIngestionResponse
createIngestionResponse_arn :: Lens' CreateIngestionResponse (Maybe Text)
createIngestionResponse_ingestionId :: Lens' CreateIngestionResponse (Maybe Text)
createIngestionResponse_ingestionStatus :: Lens' CreateIngestionResponse (Maybe IngestionStatus)
createIngestionResponse_requestId :: Lens' CreateIngestionResponse (Maybe Text)
createIngestionResponse_status :: Lens' CreateIngestionResponse Int

Creating a Request

data CreateIngestion Source #

See: newCreateIngestion smart constructor.

Constructors

CreateIngestion'
Fields ingestionType :: Maybe IngestionType The type of ingestion that you want to create. dataSetId :: Text The ID of the dataset used in the ingestion. ingestionId :: Text An ID for the ingestion. awsAccountId :: Text The Amazon Web Services account ID.

Instances

Instances details

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

newCreateIngestion Source #

Arguments

:: Text	`CreateIngestion`
-> Text	`CreateIngestion`
-> Text	`CreateIngestion`
-> CreateIngestion

Create a value of CreateIngestion 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:ingestionType:CreateIngestion', createIngestion_ingestionType - The type of ingestion that you want to create.

CreateIngestion, createIngestion_dataSetId - The ID of the dataset used in the ingestion.

CreateIngestion, createIngestion_ingestionId - An ID for the ingestion.

CreateIngestion, createIngestion_awsAccountId - The Amazon Web Services account ID.

Request Lenses

createIngestion_ingestionType :: Lens' CreateIngestion (Maybe IngestionType) Source #

The type of ingestion that you want to create.

createIngestion_dataSetId :: Lens' CreateIngestion Text Source #

The ID of the dataset used in the ingestion.

createIngestion_ingestionId :: Lens' CreateIngestion Text Source #

An ID for the ingestion.

createIngestion_awsAccountId :: Lens' CreateIngestion Text Source #

The Amazon Web Services account ID.

Destructuring the Response

data CreateIngestionResponse Source #

See: newCreateIngestionResponse smart constructor.

Constructors

CreateIngestionResponse'
Fields arn :: Maybe Text The Amazon Resource Name (ARN) for the data ingestion. ingestionId :: Maybe Text An ID for the ingestion. ingestionStatus :: Maybe IngestionStatus The ingestion status. requestId :: Maybe Text The Amazon Web Services request ID for this operation. status :: Int The HTTP status of the request.

Instances

Instances details

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

newCreateIngestionResponse Source #

Arguments

:: Int	`CreateIngestionResponse`
-> CreateIngestionResponse

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

CreateIngestionResponse, createIngestionResponse_arn - The Amazon Resource Name (ARN) for the data ingestion.

CreateIngestion, createIngestionResponse_ingestionId - An ID for the ingestion.

CreateIngestionResponse, createIngestionResponse_ingestionStatus - The ingestion status.

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

CreateIngestionResponse, createIngestionResponse_status - The HTTP status of the request.

Response Lenses

createIngestionResponse_arn :: Lens' CreateIngestionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the data ingestion.

createIngestionResponse_ingestionId :: Lens' CreateIngestionResponse (Maybe Text) Source #

An ID for the ingestion.

createIngestionResponse_ingestionStatus :: Lens' CreateIngestionResponse (Maybe IngestionStatus) Source #

The ingestion status.

createIngestionResponse_requestId :: Lens' CreateIngestionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createIngestionResponse_status :: Lens' CreateIngestionResponse Int Source #

The HTTP status of the request.