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.CustomerProfiles.PutIntegration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.

An integration can belong to only one domain.

To add or remove tags on an existing Integration, see TagResource / UntagResource.

Synopsis

data PutIntegration = PutIntegration' {
- flowDefinition :: Maybe FlowDefinition
- objectTypeName :: Maybe Text
- objectTypeNames :: Maybe (HashMap Text Text)
- tags :: Maybe (HashMap Text Text)
- uri :: Maybe Text
- domainName :: Text
}
newPutIntegration :: Text -> PutIntegration
putIntegration_flowDefinition :: Lens' PutIntegration (Maybe FlowDefinition)
putIntegration_objectTypeName :: Lens' PutIntegration (Maybe Text)
putIntegration_objectTypeNames :: Lens' PutIntegration (Maybe (HashMap Text Text))
putIntegration_tags :: Lens' PutIntegration (Maybe (HashMap Text Text))
putIntegration_uri :: Lens' PutIntegration (Maybe Text)
putIntegration_domainName :: Lens' PutIntegration Text
data PutIntegrationResponse = PutIntegrationResponse' {
- isUnstructured :: Maybe Bool
- objectTypeName :: Maybe Text
- objectTypeNames :: Maybe (HashMap Text Text)
- tags :: Maybe (HashMap Text Text)
- workflowId :: Maybe Text
- httpStatus :: Int
- domainName :: Text
- uri :: Text
- createdAt :: POSIX
- lastUpdatedAt :: POSIX
}
newPutIntegrationResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> PutIntegrationResponse
putIntegrationResponse_isUnstructured :: Lens' PutIntegrationResponse (Maybe Bool)
putIntegrationResponse_objectTypeName :: Lens' PutIntegrationResponse (Maybe Text)
putIntegrationResponse_objectTypeNames :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text))
putIntegrationResponse_tags :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text))
putIntegrationResponse_workflowId :: Lens' PutIntegrationResponse (Maybe Text)
putIntegrationResponse_httpStatus :: Lens' PutIntegrationResponse Int
putIntegrationResponse_domainName :: Lens' PutIntegrationResponse Text
putIntegrationResponse_uri :: Lens' PutIntegrationResponse Text
putIntegrationResponse_createdAt :: Lens' PutIntegrationResponse UTCTime
putIntegrationResponse_lastUpdatedAt :: Lens' PutIntegrationResponse UTCTime

Creating a Request

data PutIntegration Source #

See: newPutIntegration smart constructor.

Constructors

PutIntegration'

Fields

flowDefinition :: Maybe FlowDefinition
The configuration that controls how Customer Profiles retrieves data from the source.
objectTypeName :: Maybe Text
The name of the profile object type.
objectTypeNames :: Maybe (HashMap Text Text)
A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource.
uri :: Maybe Text
The URI of the S3 bucket or any other type of data source.
domainName :: Text
The unique name of the domain.

Instances

Instances details

ToJSON PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods toJSON :: PutIntegration -> Value # toEncoding :: PutIntegration -> Encoding # toJSONList :: [PutIntegration] -> Value # toEncodingList :: [PutIntegration] -> Encoding #
ToHeaders PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods toHeaders :: PutIntegration -> [Header] #
ToPath PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods toPath :: PutIntegration -> ByteString #
ToQuery PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods toQuery :: PutIntegration -> QueryString #
AWSRequest PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Associated Types type AWSResponse PutIntegration # Methods request :: (Service -> Service) -> PutIntegration -> Request PutIntegration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutIntegration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutIntegration))) #
Generic PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Associated Types type Rep PutIntegration :: Type -> Type # Methods from :: PutIntegration -> Rep PutIntegration x # to :: Rep PutIntegration x -> PutIntegration #
Read PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods readsPrec :: Int -> ReadS PutIntegration # readList :: ReadS [PutIntegration] # readPrec :: ReadPrec PutIntegration # readListPrec :: ReadPrec [PutIntegration] #
Show PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods showsPrec :: Int -> PutIntegration -> ShowS # show :: PutIntegration -> String # showList :: [PutIntegration] -> ShowS #
NFData PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods rnf :: PutIntegration -> () #
Eq PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods (==) :: PutIntegration -> PutIntegration -> Bool # (/=) :: PutIntegration -> PutIntegration -> Bool #
Hashable PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods hashWithSalt :: Int -> PutIntegration -> Int # hash :: PutIntegration -> Int #
type AWSResponse PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration type AWSResponse PutIntegration = PutIntegrationResponse
type Rep PutIntegration Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration type Rep PutIntegration = D1 ('MetaData "PutIntegration" "Amazonka.CustomerProfiles.PutIntegration" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "PutIntegration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "flowDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlowDefinition)) :: (S1 ('MetaSel ('Just "objectTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "objectTypeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPutIntegration Source #

Arguments

:: Text	`PutIntegration`
-> PutIntegration

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

PutIntegration, putIntegration_flowDefinition - The configuration that controls how Customer Profiles retrieves data from the source.

PutIntegration, putIntegration_objectTypeName - The name of the profile object type.

PutIntegration, putIntegration_objectTypeNames - A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

PutIntegration, putIntegration_tags - The tags used to organize, track, or control access for this resource.

PutIntegration, putIntegration_uri - The URI of the S3 bucket or any other type of data source.

PutIntegration, putIntegration_domainName - The unique name of the domain.

Request Lenses

putIntegration_flowDefinition :: Lens' PutIntegration (Maybe FlowDefinition) Source #

The configuration that controls how Customer Profiles retrieves data from the source.

putIntegration_objectTypeName :: Lens' PutIntegration (Maybe Text) Source #

The name of the profile object type.

putIntegration_objectTypeNames :: Lens' PutIntegration (Maybe (HashMap Text Text)) Source #

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

putIntegration_tags :: Lens' PutIntegration (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

putIntegration_uri :: Lens' PutIntegration (Maybe Text) Source #

The URI of the S3 bucket or any other type of data source.

putIntegration_domainName :: Lens' PutIntegration Text Source #

The unique name of the domain.

Destructuring the Response

data PutIntegrationResponse Source #

See: newPutIntegrationResponse smart constructor.

Constructors

PutIntegrationResponse'

Fields

isUnstructured :: Maybe Bool
Boolean to indicate if the Flow associated with the Integration is created via Appflow console or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition
objectTypeName :: Maybe Text
The name of the profile object type.
objectTypeNames :: Maybe (HashMap Text Text)
A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource.
workflowId :: Maybe Text
Unique identifier for the workflow.
httpStatus :: Int
The response's http status code.
domainName :: Text
The unique name of the domain.
uri :: Text
The URI of the S3 bucket or any other type of data source.
createdAt :: POSIX
The timestamp of when the domain was created.
lastUpdatedAt :: POSIX
The timestamp of when the domain was most recently edited.

Instances

Instances details

Generic PutIntegrationResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Associated Types type Rep PutIntegrationResponse :: Type -> Type # Methods from :: PutIntegrationResponse -> Rep PutIntegrationResponse x # to :: Rep PutIntegrationResponse x -> PutIntegrationResponse #
Read PutIntegrationResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods readsPrec :: Int -> ReadS PutIntegrationResponse # readList :: ReadS [PutIntegrationResponse] # readPrec :: ReadPrec PutIntegrationResponse # readListPrec :: ReadPrec [PutIntegrationResponse] #
Show PutIntegrationResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods showsPrec :: Int -> PutIntegrationResponse -> ShowS # show :: PutIntegrationResponse -> String # showList :: [PutIntegrationResponse] -> ShowS #
NFData PutIntegrationResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods rnf :: PutIntegrationResponse -> () #
Eq PutIntegrationResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration Methods (==) :: PutIntegrationResponse -> PutIntegrationResponse -> Bool # (/=) :: PutIntegrationResponse -> PutIntegrationResponse -> Bool #
type Rep PutIntegrationResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.PutIntegration type Rep PutIntegrationResponse = D1 ('MetaData "PutIntegrationResponse" "Amazonka.CustomerProfiles.PutIntegration" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "PutIntegrationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "isUnstructured") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "objectTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "objectTypeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newPutIntegrationResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutIntegrationResponse'`
-> Text	`PutIntegration`
-> Text	`PutIntegration`
-> UTCTime	`PutIntegrationResponse`
-> UTCTime	`PutIntegrationResponse`
-> PutIntegrationResponse

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

PutIntegrationResponse, putIntegrationResponse_isUnstructured - Boolean to indicate if the Flow associated with the Integration is created via Appflow console or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition

PutIntegration, putIntegrationResponse_objectTypeName - The name of the profile object type.

PutIntegration, putIntegrationResponse_objectTypeNames - A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

PutIntegration, putIntegrationResponse_tags - The tags used to organize, track, or control access for this resource.

PutIntegrationResponse, putIntegrationResponse_workflowId - Unique identifier for the workflow.

$sel:httpStatus:PutIntegrationResponse', putIntegrationResponse_httpStatus - The response's http status code.

PutIntegration, putIntegrationResponse_domainName - The unique name of the domain.

PutIntegration, putIntegrationResponse_uri - The URI of the S3 bucket or any other type of data source.

PutIntegrationResponse, putIntegrationResponse_createdAt - The timestamp of when the domain was created.

PutIntegrationResponse, putIntegrationResponse_lastUpdatedAt - The timestamp of when the domain was most recently edited.

Response Lenses

putIntegrationResponse_isUnstructured :: Lens' PutIntegrationResponse (Maybe Bool) Source #

Boolean to indicate if the Flow associated with the Integration is created via Appflow console or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition

putIntegrationResponse_objectTypeName :: Lens' PutIntegrationResponse (Maybe Text) Source #

The name of the profile object type.

putIntegrationResponse_objectTypeNames :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text)) Source #

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

putIntegrationResponse_tags :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

putIntegrationResponse_workflowId :: Lens' PutIntegrationResponse (Maybe Text) Source #

Unique identifier for the workflow.

putIntegrationResponse_httpStatus :: Lens' PutIntegrationResponse Int Source #

The response's http status code.

putIntegrationResponse_domainName :: Lens' PutIntegrationResponse Text Source #

The unique name of the domain.

putIntegrationResponse_uri :: Lens' PutIntegrationResponse Text Source #

The URI of the S3 bucket or any other type of data source.

putIntegrationResponse_createdAt :: Lens' PutIntegrationResponse UTCTime Source #

The timestamp of when the domain was created.

putIntegrationResponse_lastUpdatedAt :: Lens' PutIntegrationResponse UTCTime Source #

The timestamp of when the domain was most recently edited.