amazonka-wisdom-2.0: Amazon Connect Wisdom Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Wisdom.StartContentUpload

Description

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

Synopsis

Creating a Request

data StartContentUpload Source #

See: newStartContentUpload smart constructor.

Constructors

StartContentUpload' 

Fields

  • contentType :: Text

    The type of content to upload.

  • knowledgeBaseId :: Text

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Instances

Instances details
ToJSON StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

toJSON :: StartContentUpload -> Value #

toEncoding :: StartContentUpload -> Encoding #

toJSONList :: [StartContentUpload] -> Value #

toEncodingList :: [StartContentUpload] -> Encoding #

ToHeaders StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

toHeaders :: StartContentUpload -> [Header] #

ToPath StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

toPath :: StartContentUpload -> ByteString #

ToQuery StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

toQuery :: StartContentUpload -> QueryString #

AWSRequest StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Associated Types

type AWSResponse StartContentUpload #

Methods

request :: (Service -> Service) -> StartContentUpload -> Request StartContentUpload #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartContentUpload -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartContentUpload))) #

Generic StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Associated Types

type Rep StartContentUpload :: Type -> Type #

Methods

from :: StartContentUpload -> Rep StartContentUpload x #

to :: Rep StartContentUpload x -> StartContentUpload #

Read StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

readsPrec :: Int -> ReadS StartContentUpload #

readList :: ReadS [StartContentUpload] #

readPrec :: ReadPrec StartContentUpload #

readListPrec :: ReadPrec [StartContentUpload] #

Show StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

showsPrec :: Int -> StartContentUpload -> ShowS #

show :: StartContentUpload -> String #

showList :: [StartContentUpload] -> ShowS #

NFData StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

rnf :: StartContentUpload -> () #

Eq StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

(==) :: StartContentUpload -> StartContentUpload -> Bool #

(/=) :: StartContentUpload -> StartContentUpload -> Bool #

Hashable StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

hashWithSalt :: Int -> StartContentUpload -> Int #

hash :: StartContentUpload -> Int #

type AWSResponse StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

type AWSResponse StartContentUpload = StartContentUploadResponse
type Rep StartContentUpload Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

type Rep StartContentUpload = D1 ('MetaData "StartContentUpload" "Amazonka.Wisdom.StartContentUpload" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "StartContentUpload'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "knowledgeBaseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartContentUpload Source #

Arguments

:: Text

StartContentUpload

-> Text

StartContentUpload

-> StartContentUpload 

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

StartContentUpload, startContentUpload_contentType - The type of content to upload.

StartContentUpload, startContentUpload_knowledgeBaseId - The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Request Lenses

startContentUpload_contentType :: Lens' StartContentUpload Text Source #

The type of content to upload.

startContentUpload_knowledgeBaseId :: Lens' StartContentUpload Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Destructuring the Response

data StartContentUploadResponse Source #

See: newStartContentUploadResponse smart constructor.

Constructors

StartContentUploadResponse' 

Fields

Instances

Instances details
Generic StartContentUploadResponse Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Associated Types

type Rep StartContentUploadResponse :: Type -> Type #

Methods

from :: StartContentUploadResponse -> Rep StartContentUploadResponse x #

to :: Rep StartContentUploadResponse x -> StartContentUploadResponse #

Show StartContentUploadResponse Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

showsPrec :: Int -> StartContentUploadResponse -> ShowS #

show :: StartContentUploadResponse -> String #

showList :: [StartContentUploadResponse] -> ShowS #

NFData StartContentUploadResponse Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

rnf :: StartContentUploadResponse -> () #

Eq StartContentUploadResponse Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

Methods

(==) :: StartContentUploadResponse -> StartContentUploadResponse -> Bool #

(/=) :: StartContentUploadResponse -> StartContentUploadResponse -> Bool #

type Rep StartContentUploadResponse Source # 
Instance details

Defined in Amazonka.Wisdom.StartContentUpload

type Rep StartContentUploadResponse = D1 ('MetaData "StartContentUploadResponse" "Amazonka.Wisdom.StartContentUpload" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "StartContentUploadResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "headersToInclude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "uploadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "urlExpiry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newStartContentUploadResponse Source #

Arguments

:: Int

$sel:httpStatus:StartContentUploadResponse'

-> Text

$sel:uploadId:StartContentUploadResponse'

-> Text

StartContentUploadResponse

-> UTCTime

StartContentUploadResponse

-> StartContentUploadResponse 

Create a value of StartContentUploadResponse 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:StartContentUploadResponse', startContentUploadResponse_httpStatus - The response's http status code.

$sel:headersToInclude:StartContentUploadResponse', startContentUploadResponse_headersToInclude - The headers to include in the upload.

$sel:uploadId:StartContentUploadResponse', startContentUploadResponse_uploadId - The identifier of the upload.

StartContentUploadResponse, startContentUploadResponse_url - The URL of the upload.

StartContentUploadResponse, startContentUploadResponse_urlExpiry - The expiration time of the URL as an epoch timestamp.

Response Lenses

startContentUploadResponse_httpStatus :: Lens' StartContentUploadResponse Int Source #

The response's http status code.

startContentUploadResponse_headersToInclude :: Lens' StartContentUploadResponse (HashMap Text Text) Source #

The headers to include in the upload.

startContentUploadResponse_uploadId :: Lens' StartContentUploadResponse Text Source #

The identifier of the upload.

startContentUploadResponse_url :: Lens' StartContentUploadResponse Text Source #

The URL of the upload.

startContentUploadResponse_urlExpiry :: Lens' StartContentUploadResponse UTCTime Source #

The expiration time of the URL as an epoch timestamp.