{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.CustomerProfiles.PutIntegration -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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 -- -- \/ -- . module Amazonka.CustomerProfiles.PutIntegration ( -- * Creating a Request PutIntegration (..), newPutIntegration, -- * Request Lenses putIntegration_flowDefinition, putIntegration_objectTypeName, putIntegration_objectTypeNames, putIntegration_tags, putIntegration_uri, putIntegration_domainName, -- * Destructuring the Response PutIntegrationResponse (..), newPutIntegrationResponse, -- * Response Lenses putIntegrationResponse_isUnstructured, putIntegrationResponse_objectTypeName, putIntegrationResponse_objectTypeNames, putIntegrationResponse_tags, putIntegrationResponse_workflowId, putIntegrationResponse_httpStatus, putIntegrationResponse_domainName, putIntegrationResponse_uri, putIntegrationResponse_createdAt, putIntegrationResponse_lastUpdatedAt, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import Amazonka.CustomerProfiles.Types import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newPutIntegration' smart constructor. data PutIntegration = PutIntegration' { -- | The configuration that controls how Customer Profiles retrieves data -- from the source. flowDefinition :: Prelude.Maybe FlowDefinition, -- | The name of the profile object type. objectTypeName :: Prelude.Maybe Prelude.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@. objectTypeNames :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text), -- | The tags used to organize, track, or control access for this resource. tags :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text), -- | The URI of the S3 bucket or any other type of data source. uri :: Prelude.Maybe Prelude.Text, -- | The unique name of the domain. domainName :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'PutIntegration' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'flowDefinition', 'putIntegration_flowDefinition' - The configuration that controls how Customer Profiles retrieves data -- from the source. -- -- 'objectTypeName', 'putIntegration_objectTypeName' - The name of the profile object type. -- -- 'objectTypeNames', '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@. -- -- 'tags', 'putIntegration_tags' - The tags used to organize, track, or control access for this resource. -- -- 'uri', 'putIntegration_uri' - The URI of the S3 bucket or any other type of data source. -- -- 'domainName', 'putIntegration_domainName' - The unique name of the domain. newPutIntegration :: -- | 'domainName' Prelude.Text -> PutIntegration newPutIntegration pDomainName_ = PutIntegration' { flowDefinition = Prelude.Nothing, objectTypeName = Prelude.Nothing, objectTypeNames = Prelude.Nothing, tags = Prelude.Nothing, uri = Prelude.Nothing, domainName = pDomainName_ } -- | The configuration that controls how Customer Profiles retrieves data -- from the source. putIntegration_flowDefinition :: Lens.Lens' PutIntegration (Prelude.Maybe FlowDefinition) putIntegration_flowDefinition = Lens.lens (\PutIntegration' {flowDefinition} -> flowDefinition) (\s@PutIntegration' {} a -> s {flowDefinition = a} :: PutIntegration) -- | The name of the profile object type. putIntegration_objectTypeName :: Lens.Lens' PutIntegration (Prelude.Maybe Prelude.Text) putIntegration_objectTypeName = Lens.lens (\PutIntegration' {objectTypeName} -> objectTypeName) (\s@PutIntegration' {} a -> s {objectTypeName = a} :: PutIntegration) -- | 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_objectTypeNames :: Lens.Lens' PutIntegration (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) putIntegration_objectTypeNames = Lens.lens (\PutIntegration' {objectTypeNames} -> objectTypeNames) (\s@PutIntegration' {} a -> s {objectTypeNames = a} :: PutIntegration) Prelude.. Lens.mapping Lens.coerced -- | The tags used to organize, track, or control access for this resource. putIntegration_tags :: Lens.Lens' PutIntegration (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) putIntegration_tags = Lens.lens (\PutIntegration' {tags} -> tags) (\s@PutIntegration' {} a -> s {tags = a} :: PutIntegration) Prelude.. Lens.mapping Lens.coerced -- | The URI of the S3 bucket or any other type of data source. putIntegration_uri :: Lens.Lens' PutIntegration (Prelude.Maybe Prelude.Text) putIntegration_uri = Lens.lens (\PutIntegration' {uri} -> uri) (\s@PutIntegration' {} a -> s {uri = a} :: PutIntegration) -- | The unique name of the domain. putIntegration_domainName :: Lens.Lens' PutIntegration Prelude.Text putIntegration_domainName = Lens.lens (\PutIntegration' {domainName} -> domainName) (\s@PutIntegration' {} a -> s {domainName = a} :: PutIntegration) instance Core.AWSRequest PutIntegration where type AWSResponse PutIntegration = PutIntegrationResponse request overrides = Request.putJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> PutIntegrationResponse' Prelude.<$> (x Data..?> "IsUnstructured") Prelude.<*> (x Data..?> "ObjectTypeName") Prelude.<*> ( x Data..?> "ObjectTypeNames" Core..!@ Prelude.mempty ) Prelude.<*> (x Data..?> "Tags" Core..!@ Prelude.mempty) Prelude.<*> (x Data..?> "WorkflowId") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) Prelude.<*> (x Data..:> "DomainName") Prelude.<*> (x Data..:> "Uri") Prelude.<*> (x Data..:> "CreatedAt") Prelude.<*> (x Data..:> "LastUpdatedAt") ) instance Prelude.Hashable PutIntegration where hashWithSalt _salt PutIntegration' {..} = _salt `Prelude.hashWithSalt` flowDefinition `Prelude.hashWithSalt` objectTypeName `Prelude.hashWithSalt` objectTypeNames `Prelude.hashWithSalt` tags `Prelude.hashWithSalt` uri `Prelude.hashWithSalt` domainName instance Prelude.NFData PutIntegration where rnf PutIntegration' {..} = Prelude.rnf flowDefinition `Prelude.seq` Prelude.rnf objectTypeName `Prelude.seq` Prelude.rnf objectTypeNames `Prelude.seq` Prelude.rnf tags `Prelude.seq` Prelude.rnf uri `Prelude.seq` Prelude.rnf domainName instance Data.ToHeaders PutIntegration where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON PutIntegration where toJSON PutIntegration' {..} = Data.object ( Prelude.catMaybes [ ("FlowDefinition" Data..=) Prelude.<$> flowDefinition, ("ObjectTypeName" Data..=) Prelude.<$> objectTypeName, ("ObjectTypeNames" Data..=) Prelude.<$> objectTypeNames, ("Tags" Data..=) Prelude.<$> tags, ("Uri" Data..=) Prelude.<$> uri ] ) instance Data.ToPath PutIntegration where toPath PutIntegration' {..} = Prelude.mconcat ["/domains/", Data.toBS domainName, "/integrations"] instance Data.ToQuery PutIntegration where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newPutIntegrationResponse' smart constructor. data PutIntegrationResponse = PutIntegrationResponse' { -- | 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 isUnstructured :: Prelude.Maybe Prelude.Bool, -- | The name of the profile object type. objectTypeName :: Prelude.Maybe Prelude.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@. objectTypeNames :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text), -- | The tags used to organize, track, or control access for this resource. tags :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text), -- | Unique identifier for the workflow. workflowId :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int, -- | The unique name of the domain. domainName :: Prelude.Text, -- | The URI of the S3 bucket or any other type of data source. uri :: Prelude.Text, -- | The timestamp of when the domain was created. createdAt :: Data.POSIX, -- | The timestamp of when the domain was most recently edited. lastUpdatedAt :: Data.POSIX } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'PutIntegrationResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'isUnstructured', '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 -- -- 'objectTypeName', 'putIntegrationResponse_objectTypeName' - The name of the profile object type. -- -- 'objectTypeNames', '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@. -- -- 'tags', 'putIntegrationResponse_tags' - The tags used to organize, track, or control access for this resource. -- -- 'workflowId', 'putIntegrationResponse_workflowId' - Unique identifier for the workflow. -- -- 'httpStatus', 'putIntegrationResponse_httpStatus' - The response's http status code. -- -- 'domainName', 'putIntegrationResponse_domainName' - The unique name of the domain. -- -- 'uri', 'putIntegrationResponse_uri' - The URI of the S3 bucket or any other type of data source. -- -- 'createdAt', 'putIntegrationResponse_createdAt' - The timestamp of when the domain was created. -- -- 'lastUpdatedAt', 'putIntegrationResponse_lastUpdatedAt' - The timestamp of when the domain was most recently edited. newPutIntegrationResponse :: -- | 'httpStatus' Prelude.Int -> -- | 'domainName' Prelude.Text -> -- | 'uri' Prelude.Text -> -- | 'createdAt' Prelude.UTCTime -> -- | 'lastUpdatedAt' Prelude.UTCTime -> PutIntegrationResponse newPutIntegrationResponse pHttpStatus_ pDomainName_ pUri_ pCreatedAt_ pLastUpdatedAt_ = PutIntegrationResponse' { isUnstructured = Prelude.Nothing, objectTypeName = Prelude.Nothing, objectTypeNames = Prelude.Nothing, tags = Prelude.Nothing, workflowId = Prelude.Nothing, httpStatus = pHttpStatus_, domainName = pDomainName_, uri = pUri_, createdAt = Data._Time Lens.# pCreatedAt_, lastUpdatedAt = Data._Time Lens.# pLastUpdatedAt_ } -- | 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_isUnstructured :: Lens.Lens' PutIntegrationResponse (Prelude.Maybe Prelude.Bool) putIntegrationResponse_isUnstructured = Lens.lens (\PutIntegrationResponse' {isUnstructured} -> isUnstructured) (\s@PutIntegrationResponse' {} a -> s {isUnstructured = a} :: PutIntegrationResponse) -- | The name of the profile object type. putIntegrationResponse_objectTypeName :: Lens.Lens' PutIntegrationResponse (Prelude.Maybe Prelude.Text) putIntegrationResponse_objectTypeName = Lens.lens (\PutIntegrationResponse' {objectTypeName} -> objectTypeName) (\s@PutIntegrationResponse' {} a -> s {objectTypeName = a} :: PutIntegrationResponse) -- | 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_objectTypeNames :: Lens.Lens' PutIntegrationResponse (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) putIntegrationResponse_objectTypeNames = Lens.lens (\PutIntegrationResponse' {objectTypeNames} -> objectTypeNames) (\s@PutIntegrationResponse' {} a -> s {objectTypeNames = a} :: PutIntegrationResponse) Prelude.. Lens.mapping Lens.coerced -- | The tags used to organize, track, or control access for this resource. putIntegrationResponse_tags :: Lens.Lens' PutIntegrationResponse (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) putIntegrationResponse_tags = Lens.lens (\PutIntegrationResponse' {tags} -> tags) (\s@PutIntegrationResponse' {} a -> s {tags = a} :: PutIntegrationResponse) Prelude.. Lens.mapping Lens.coerced -- | Unique identifier for the workflow. putIntegrationResponse_workflowId :: Lens.Lens' PutIntegrationResponse (Prelude.Maybe Prelude.Text) putIntegrationResponse_workflowId = Lens.lens (\PutIntegrationResponse' {workflowId} -> workflowId) (\s@PutIntegrationResponse' {} a -> s {workflowId = a} :: PutIntegrationResponse) -- | The response's http status code. putIntegrationResponse_httpStatus :: Lens.Lens' PutIntegrationResponse Prelude.Int putIntegrationResponse_httpStatus = Lens.lens (\PutIntegrationResponse' {httpStatus} -> httpStatus) (\s@PutIntegrationResponse' {} a -> s {httpStatus = a} :: PutIntegrationResponse) -- | The unique name of the domain. putIntegrationResponse_domainName :: Lens.Lens' PutIntegrationResponse Prelude.Text putIntegrationResponse_domainName = Lens.lens (\PutIntegrationResponse' {domainName} -> domainName) (\s@PutIntegrationResponse' {} a -> s {domainName = a} :: PutIntegrationResponse) -- | The URI of the S3 bucket or any other type of data source. putIntegrationResponse_uri :: Lens.Lens' PutIntegrationResponse Prelude.Text putIntegrationResponse_uri = Lens.lens (\PutIntegrationResponse' {uri} -> uri) (\s@PutIntegrationResponse' {} a -> s {uri = a} :: PutIntegrationResponse) -- | The timestamp of when the domain was created. putIntegrationResponse_createdAt :: Lens.Lens' PutIntegrationResponse Prelude.UTCTime putIntegrationResponse_createdAt = Lens.lens (\PutIntegrationResponse' {createdAt} -> createdAt) (\s@PutIntegrationResponse' {} a -> s {createdAt = a} :: PutIntegrationResponse) Prelude.. Data._Time -- | The timestamp of when the domain was most recently edited. putIntegrationResponse_lastUpdatedAt :: Lens.Lens' PutIntegrationResponse Prelude.UTCTime putIntegrationResponse_lastUpdatedAt = Lens.lens (\PutIntegrationResponse' {lastUpdatedAt} -> lastUpdatedAt) (\s@PutIntegrationResponse' {} a -> s {lastUpdatedAt = a} :: PutIntegrationResponse) Prelude.. Data._Time instance Prelude.NFData PutIntegrationResponse where rnf PutIntegrationResponse' {..} = Prelude.rnf isUnstructured `Prelude.seq` Prelude.rnf objectTypeName `Prelude.seq` Prelude.rnf objectTypeNames `Prelude.seq` Prelude.rnf tags `Prelude.seq` Prelude.rnf workflowId `Prelude.seq` Prelude.rnf httpStatus `Prelude.seq` Prelude.rnf domainName `Prelude.seq` Prelude.rnf uri `Prelude.seq` Prelude.rnf createdAt `Prelude.seq` Prelude.rnf lastUpdatedAt