+ * Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. + *
+ */ + public createIntegrationWorkflow( + args: CreateIntegrationWorkflowCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates a standard profile.
*A standard profile represents the following attributes for a customer profile in a @@ -464,6 +519,38 @@ export class CustomerProfiles extends CustomerProfilesClient { } } + /** + *
Deletes the specified workflow and all its corresponding resources. This is an async process.
+ */ + public deleteWorkflow( + args: DeleteWorkflowCommandInput, + options?: __HttpHandlerOptions + ): PromiseTests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly * selects a sample of matching groups from the existing matching results, and applies the @@ -643,9 +730,6 @@ export class CustomerProfiles extends CustomerProfilesClient { *
FullName
*BusinessName
- *For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing * email addresses such as JOHN_DOE@ANYCOMPANY.COM and @@ -743,6 +827,64 @@ export class CustomerProfiles extends CustomerProfilesClient { } } + /** + *
Get details of specified workflow.
+ */ + public getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): PromiseGet granular list of steps in workflow.
+ */ + public getWorkflowSteps( + args: GetWorkflowStepsCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists all of the integrations associated to a specific URI in the AWS account.
*/ @@ -995,6 +1137,38 @@ export class CustomerProfiles extends CustomerProfilesClient { } } + /** + *Query to list all workflows.
+ */ + public listWorkflows( + args: ListWorkflowsCommandInput, + options?: __HttpHandlerOptions + ): PromiseRuns an AWS Lambda job that does the following:
*+ * Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, CreateIntegrationWorkflowCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, CreateIntegrationWorkflowCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new CreateIntegrationWorkflowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIntegrationWorkflowCommandInput} for command's `input` shape. + * @see {@link CreateIntegrationWorkflowCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape. + * + */ +export class CreateIntegrationWorkflowCommand extends $Command< + CreateIntegrationWorkflowCommandInput, + CreateIntegrationWorkflowCommandOutput, + CustomerProfilesClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateIntegrationWorkflowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the specified workflow and all its corresponding resources. This is an async process.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, DeleteWorkflowCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, DeleteWorkflowCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new DeleteWorkflowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkflowCommandInput} for command's `input` shape. + * @see {@link DeleteWorkflowCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape. + * + */ +export class DeleteWorkflowCommand extends $Command< + DeleteWorkflowCommandInput, + DeleteWorkflowCommandOutput, + CustomerProfilesClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteWorkflowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackFullName
*BusinessName
- *For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing * email addresses such as JOHN_DOE@ANYCOMPANY.COM and diff --git a/clients/client-customer-profiles/src/commands/GetWorkflowCommand.ts b/clients/client-customer-profiles/src/commands/GetWorkflowCommand.ts new file mode 100644 index 000000000000..9b2c1d54a1fa --- /dev/null +++ b/clients/client-customer-profiles/src/commands/GetWorkflowCommand.ts @@ -0,0 +1,95 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient"; +import { GetWorkflowRequest, GetWorkflowResponse } from "../models/models_0"; +import { + deserializeAws_restJson1GetWorkflowCommand, + serializeAws_restJson1GetWorkflowCommand, +} from "../protocols/Aws_restJson1"; + +export interface GetWorkflowCommandInput extends GetWorkflowRequest {} +export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __MetadataBearer {} + +/** + *
Get details of specified workflow.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, GetWorkflowCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, GetWorkflowCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new GetWorkflowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorkflowCommandInput} for command's `input` shape. + * @see {@link GetWorkflowCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape. + * + */ +export class GetWorkflowCommand extends $Command< + GetWorkflowCommandInput, + GetWorkflowCommandOutput, + CustomerProfilesClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetWorkflowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGet granular list of steps in workflow.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, GetWorkflowStepsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, GetWorkflowStepsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new GetWorkflowStepsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorkflowStepsCommandInput} for command's `input` shape. + * @see {@link GetWorkflowStepsCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape. + * + */ +export class GetWorkflowStepsCommand extends $Command< + GetWorkflowStepsCommandInput, + GetWorkflowStepsCommandOutput, + CustomerProfilesClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetWorkflowStepsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackQuery to list all workflows.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, ListWorkflowsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, ListWorkflowsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new ListWorkflowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkflowsCommandInput} for command's `input` shape. + * @see {@link ListWorkflowsCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape. + * + */ +export class ListWorkflowsCommand extends $Command< + ListWorkflowsCommandInput, + ListWorkflowsCommandOutput, + CustomerProfilesClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListWorkflowsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackBatch defines the boundaries for ingestion for each step in APPFLOW_INTEGRATION workflow. APPFLOW_INTEGRATION workflow splits ingestion based on these boundaries.
Start time of batch to split ingestion.
+ */ + StartTime: Date | undefined; + + /** + *End time of batch to split ingestion.
+ */ + EndTime: Date | undefined; +} + +export namespace Batch { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Batch): any => ({ + ...obj, + }); +} + +export enum SourceConnectorType { + MARKETO = "Marketo", + S3 = "S3", + SALESFORCE = "Salesforce", + SERVICENOW = "Servicenow", + ZENDESK = "Zendesk", } /** - *How the auto-merging process should resolve conflicts between different profiles.
+ *Specifies the configuration used when importing incremental records from the + * source.
*/ -export interface ConflictResolution { +export interface IncrementalPullConfig { /** - *How the auto-merging process should resolve conflicts between different profiles.
- *
- * RECENCY: Uses the data that was most recently updated.
- * SOURCE: Uses the data from a specific source. For example, if a
- * company has been aquired or two departments have merged, data from the specified
- * source is used. If two duplicate profiles are from the same source, then
- * RECENCY is used again.
A field that specifies the date time or timestamp field as the criteria to use when + * importing incremental records from the source.
*/ - ConflictResolvingModel: ConflictResolvingModel | string | undefined; + DatetimeTypeFieldName?: string; +} +export namespace IncrementalPullConfig { /** - *The ObjectType name that is used to resolve profile merging conflicts when
- * choosing SOURCE as the ConflictResolvingModel.
The properties that are applied when Marketo is being used as a source.
+ */ +export interface MarketoSourceProperties { + /** + *The object specified in the Marketo flow source.
+ */ + Object: string | undefined; +} + +export namespace MarketoSourceProperties { /** * @internal */ - export const filterSensitiveLog = (obj: ConflictResolution): any => ({ + export const filterSensitiveLog = (obj: MarketoSourceProperties): any => ({ ...obj, }); } /** - *The matching criteria to be used during the auto-merging process.
+ *The properties that are applied when Amazon S3 is being used as the flow source.
*/ -export interface Consolidation { +export interface S3SourceProperties { /** - *A list of matching criteria.
+ *The Amazon S3 bucket name where the source files are stored.
*/ - MatchingAttributesList: string[][] | undefined; + BucketName: string | undefined; + + /** + *The object key for the Amazon S3 bucket in which the source files are stored.
+ */ + BucketPrefix?: string; } -export namespace Consolidation { +export namespace S3SourceProperties { /** * @internal */ - export const filterSensitiveLog = (obj: Consolidation): any => ({ + export const filterSensitiveLog = (obj: S3SourceProperties): any => ({ ...obj, }); } /** - *Configuration settings for how to perform the auto-merging of profiles.
+ *The properties that are applied when Salesforce is being used as a source.
*/ -export interface AutoMerging { +export interface SalesforceSourceProperties { /** - *The flag that enables the auto-merging of duplicate profiles.
+ *The object specified in the Salesforce flow source.
*/ - Enabled: boolean | undefined; + Object: string | undefined; /** - *A list of matching attributes that represent matching criteria. If two profiles meet at - * least one of the requirements in the matching attributes list, they will be merged.
+ *The flag that enables dynamic fetching of new (recently added) fields in the Salesforce + * objects while running a flow.
*/ - Consolidation?: Consolidation; + EnableDynamicFieldUpdate?: boolean; /** - *How the auto-merging process should resolve conflicts between different profiles. For
- * example, if Profile A and Profile B have the same FirstName and
- * LastName (and that is the matching criteria), which
- * EmailAddress should be used?
Indicates whether Amazon AppFlow includes deleted files in the flow run.
*/ - ConflictResolution?: ConflictResolution; + IncludeDeletedRecords?: boolean; } -export namespace AutoMerging { +export namespace SalesforceSourceProperties { /** * @internal */ - export const filterSensitiveLog = (obj: AutoMerging): any => ({ + export const filterSensitiveLog = (obj: SalesforceSourceProperties): any => ({ + ...obj, + }); +} + +/** + *The properties that are applied when ServiceNow is being used as a source.
+ */ +export interface ServiceNowSourceProperties { + /** + *The object specified in the ServiceNow flow source.
+ */ + Object: string | undefined; +} + +export namespace ServiceNowSourceProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ServiceNowSourceProperties): any => ({ + ...obj, + }); +} + +/** + *The properties that are applied when using Zendesk as a flow source.
+ */ +export interface ZendeskSourceProperties { + /** + *The object specified in the Zendesk flow source.
+ */ + Object: string | undefined; +} + +export namespace ZendeskSourceProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ZendeskSourceProperties): any => ({ + ...obj, + }); +} + +/** + *Specifies the information that is required to query a particular Amazon AppFlow connector. + * Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.
+ */ +export interface SourceConnectorProperties { + /** + *The properties that are applied when Marketo is being used as a source.
+ */ + Marketo?: MarketoSourceProperties; + + /** + *The properties that are applied when Amazon S3 is being used as the flow source.
+ */ + S3?: S3SourceProperties; + + /** + *The properties that are applied when Salesforce is being used as a source.
+ */ + Salesforce?: SalesforceSourceProperties; + + /** + *The properties that are applied when ServiceNow is being used as a source.
+ */ + ServiceNow?: ServiceNowSourceProperties; + + /** + *The properties that are applied when using Zendesk as a flow source.
+ */ + Zendesk?: ZendeskSourceProperties; +} + +export namespace SourceConnectorProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SourceConnectorProperties): any => ({ + ...obj, + }); +} + +/** + *Contains information about the configuration of the source connector used in the + * flow.
+ */ +export interface SourceFlowConfig { + /** + *The name of the AppFlow connector profile. This name must be unique for each connector + * profile in the AWS account.
+ */ + ConnectorProfileName?: string; + + /** + *The type of connector, such as Salesforce, Marketo, and so on.
+ */ + ConnectorType: SourceConnectorType | string | undefined; + + /** + *Defines the configuration for a scheduled incremental data pull. If a valid + * configuration is provided, the fields specified in the configuration are used when querying + * for the incremental data pull.
+ */ + IncrementalPullConfig?: IncrementalPullConfig; + + /** + *Specifies the information that is required to query a particular source + * connector.
+ */ + SourceConnectorProperties: SourceConnectorProperties | undefined; +} + +export namespace SourceFlowConfig { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SourceFlowConfig): any => ({ ...obj, }); } @@ -466,17 +614,490 @@ export namespace ConnectorOperator { }); } -/** - *Configuration information about the S3 bucket where Identity Resolution Jobs write result files.
- */ -export interface S3ExportingConfig { - /** - *The name of the S3 bucket where Identity Resolution Jobs write result files.
- */ - S3BucketName: string | undefined; +export enum OperatorPropertiesKeys { + CONCAT_FORMAT = "CONCAT_FORMAT", + DATA_TYPE = "DATA_TYPE", + DESTINATION_DATA_TYPE = "DESTINATION_DATA_TYPE", + LOWER_BOUND = "LOWER_BOUND", + MASK_LENGTH = "MASK_LENGTH", + MASK_VALUE = "MASK_VALUE", + MATH_OPERATION_FIELDS_ORDER = "MATH_OPERATION_FIELDS_ORDER", + SOURCE_DATA_TYPE = "SOURCE_DATA_TYPE", + SUBFIELD_CATEGORY_MAP = "SUBFIELD_CATEGORY_MAP", + TRUNCATE_LENGTH = "TRUNCATE_LENGTH", + UPPER_BOUND = "UPPER_BOUND", + VALIDATION_ACTION = "VALIDATION_ACTION", + VALUE = "VALUE", + VALUES = "VALUES", +} - /** - *The S3 key name of the location where Identity Resolution Jobs write result files.
+export enum TaskType { + ARITHMETIC = "Arithmetic", + FILTER = "Filter", + MAP = "Map", + MASK = "Mask", + MERGE = "Merge", + TRUNCATE = "Truncate", + VALIDATE = "Validate", +} + +/** + *A class for modeling different type of tasks. Task implementation varies based on the + * TaskType.
+ */ +export interface Task { + /** + *The operation to be performed on the provided source fields.
+ */ + ConnectorOperator?: ConnectorOperator; + + /** + *A field in a destination connector, or a field value against which Amazon AppFlow validates a + * source field.
+ */ + DestinationField?: string; + + /** + *The source fields to which a particular task is applied.
+ */ + SourceFields: string[] | undefined; + + /** + *A map used to store task-related information. The service looks for particular + * information based on the TaskType.
+ */ + TaskProperties?: { [key: string]: string }; + + /** + *Specifies the particular task implementation that Amazon AppFlow performs.
+ */ + TaskType: TaskType | string | undefined; +} + +export namespace Task { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Task): any => ({ + ...obj, + }); +} + +export enum DataPullMode { + COMPLETE = "Complete", + INCREMENTAL = "Incremental", +} + +/** + *Specifies the configuration details of a scheduled-trigger flow that you define. + * Currently, these settings only apply to the scheduled-trigger type.
+ */ +export interface ScheduledTriggerProperties { + /** + *The scheduling expression that determines the rate at which the schedule will run, for + * example rate (5 minutes).
+ */ + ScheduleExpression: string | undefined; + + /** + *Specifies whether a scheduled flow has an incremental data transfer or a complete data + * transfer for each flow run.
+ */ + DataPullMode?: DataPullMode | string; + + /** + *Specifies the scheduled start time for a scheduled-trigger flow.
+ */ + ScheduleStartTime?: Date; + + /** + *Specifies the scheduled end time for a scheduled-trigger flow.
+ */ + ScheduleEndTime?: Date; + + /** + *Specifies the time zone used when referring to the date and time of a + * scheduled-triggered flow, such as America/New_York.
+ */ + Timezone?: string; + + /** + *Specifies the optional offset that is added to the time interval for a + * schedule-triggered flow.
+ */ + ScheduleOffset?: number; + + /** + *Specifies the date range for the records to import from the connector in the first flow + * run.
+ */ + FirstExecutionFrom?: Date; +} + +export namespace ScheduledTriggerProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ScheduledTriggerProperties): any => ({ + ...obj, + }); +} + +/** + *Specifies the configuration details that control the trigger for a flow. Currently, + * these settings only apply to the Scheduled trigger type.
+ */ +export interface TriggerProperties { + /** + *Specifies the configuration details of a schedule-triggered flow that you define.
+ */ + Scheduled?: ScheduledTriggerProperties; +} + +export namespace TriggerProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TriggerProperties): any => ({ + ...obj, + }); +} + +export enum TriggerType { + EVENT = "Event", + ONDEMAND = "OnDemand", + SCHEDULED = "Scheduled", +} + +/** + *The trigger settings that determine how and when Amazon AppFlow runs the specified + * flow.
+ */ +export interface TriggerConfig { + /** + *Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
+ */ + TriggerType: TriggerType | string | undefined; + + /** + *Specifies the configuration details of a schedule-triggered flow that you define. + * Currently, these settings only apply to the Scheduled trigger type.
+ */ + TriggerProperties?: TriggerProperties; +} + +export namespace TriggerConfig { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TriggerConfig): any => ({ + ...obj, + }); +} + +/** + *The configurations that control how Customer Profiles retrieves data from the source, + * Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of + * customers.
+ */ +export interface FlowDefinition { + /** + *A description of the flow you want to create.
+ */ + Description?: string; + + /** + *The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not + * allowed.
+ */ + FlowName: string | undefined; + + /** + *The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
+ */ + KmsArn: string | undefined; + + /** + *The configuration that controls how Customer Profiles retrieves data from the + * source.
+ */ + SourceFlowConfig: SourceFlowConfig | undefined; + + /** + *A list of tasks that Customer Profiles performs while transferring the data in the flow + * run.
+ */ + Tasks: Task[] | undefined; + + /** + *The trigger settings that determine how and when the flow runs.
+ */ + TriggerConfig: TriggerConfig | undefined; +} + +export namespace FlowDefinition { + /** + * @internal + */ + export const filterSensitiveLog = (obj: FlowDefinition): any => ({ + ...obj, + }); +} + +/** + *Details for workflow of type APPFLOW_INTEGRATION.
The configurations that control how Customer Profiles retrieves data from the source, + * Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of + * customers.
+ */ + FlowDefinition: FlowDefinition | undefined; + + /** + *Batches in workflow of type APPFLOW_INTEGRATION.
Structure holding all APPFLOW_INTEGRATION specific workflow attributes.
Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.
+ */ + SourceConnectorType: SourceConnectorType | string | undefined; + + /** + *The name of the AppFlow connector profile used for ingestion.
+ */ + ConnectorProfileName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.
+ */ + RoleArn?: string; +} + +export namespace AppflowIntegrationWorkflowAttributes { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AppflowIntegrationWorkflowAttributes): any => ({ + ...obj, + }); +} + +/** + *Workflow specific execution metrics for APPFLOW_INTEGRATION workflow.
Number of records processed in APPFLOW_INTEGRATION workflow.
Total steps completed in APPFLOW_INTEGRATION workflow.
Total steps in APPFLOW_INTEGRATION workflow.
Workflow step details for APPFLOW_INTEGRATION workflow.
Name of the flow created during execution of workflow step. APPFLOW_INTEGRATION workflow type creates an appflow flow during workflow step execution on the customers behalf.
Workflow step status for APPFLOW_INTEGRATION workflow.
Message indicating execution of workflow step for APPFLOW_INTEGRATION workflow.
Total number of records processed during execution of workflow step for APPFLOW_INTEGRATION workflow.
Start datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.
End datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.
Creation timestamp of workflow step for APPFLOW_INTEGRATION workflow.
Last updated timestamp for workflow step for APPFLOW_INTEGRATION workflow.
How the auto-merging process should resolve conflicts between different profiles.
+ */ +export interface ConflictResolution { + /** + *How the auto-merging process should resolve conflicts between different profiles.
+ *
+ * RECENCY: Uses the data that was most recently updated.
+ * SOURCE: Uses the data from a specific source. For example, if a
+ * company has been aquired or two departments have merged, data from the specified
+ * source is used. If two duplicate profiles are from the same source, then
+ * RECENCY is used again.
The ObjectType name that is used to resolve profile merging conflicts when
+ * choosing SOURCE as the ConflictResolvingModel.
The matching criteria to be used during the auto-merging process.
+ */ +export interface Consolidation { + /** + *A list of matching criteria.
+ */ + MatchingAttributesList: string[][] | undefined; +} + +export namespace Consolidation { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Consolidation): any => ({ + ...obj, + }); +} + +/** + *Configuration settings for how to perform the auto-merging of profiles.
+ */ +export interface AutoMerging { + /** + *The flag that enables the auto-merging of duplicate profiles.
+ */ + Enabled: boolean | undefined; + + /** + *A list of matching attributes that represent matching criteria. If two profiles meet at + * least one of the requirements in the matching attributes list, they will be merged.
+ */ + Consolidation?: Consolidation; + + /** + *How the auto-merging process should resolve conflicts between different profiles. For
+ * example, if Profile A and Profile B have the same FirstName and
+ * LastName (and that is the matching criteria), which
+ * EmailAddress should be used?
Configuration information about the S3 bucket where Identity Resolution Jobs write result files.
+ */ +export interface S3ExportingConfig { + /** + *The name of the S3 bucket where Identity Resolution Jobs write result files.
+ */ + S3BucketName: string | undefined; + + /** + *The S3 key name of the location where Identity Resolution Jobs write result files.
*/ S3KeyName?: string; } @@ -650,82 +1271,167 @@ export interface MatchingResponse { JobSchedule?: JobSchedule; /** - *Configuration information about the auto-merging process.
+ *Configuration information about the auto-merging process.
+ */ + AutoMerging?: AutoMerging; + + /** + *Configuration information for exporting Identity Resolution results, for example, to an S3 + * bucket.
+ */ + ExportingConfig?: ExportingConfig; +} + +export namespace MatchingResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MatchingResponse): any => ({ + ...obj, + }); +} + +export interface CreateDomainResponse { + /** + *The unique name of the domain.
+ */ + DomainName: string | undefined; + + /** + *The default number of days until the data within the domain expires.
+ */ + DefaultExpirationDays: number | undefined; + + /** + *The default encryption key, which is an AWS managed key, is used when no specific type + * of encryption key is specified. It is used to encrypt all data before it is placed in + * permanent or semi-permanent storage.
+ */ + DefaultEncryptionKey?: string; + + /** + *The URL of the SQS dead letter queue, which is used for reporting errors associated with + * ingesting data from third party applications.
+ */ + DeadLetterQueueUrl?: string; + + /** + *The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly
+ * batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every
+ * Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the
+ * GetMatches
+ * API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from
+ * S3.
The timestamp of when the domain was created.
+ */ + CreatedAt: Date | undefined; + + /** + *The timestamp of when the domain was most recently edited.
+ */ + LastUpdatedAt: Date | undefined; + + /** + *The tags used to organize, track, or control access for this resource.
+ */ + Tags?: { [key: string]: string }; +} + +export namespace CreateDomainResponse { + /** + * @internal */ - AutoMerging?: AutoMerging; + export const filterSensitiveLog = (obj: CreateDomainResponse): any => ({ + ...obj, + }); +} +/** + *Configuration data for integration workflow.
+ */ +export interface IntegrationConfig { /** - *Configuration information for exporting Identity Resolution results, for example, to an S3 - * bucket.
+ *Configuration data for APPFLOW_INTEGRATION workflow type.
The unique name of the domain.
*/ DomainName: string | undefined; /** - *The default number of days until the data within the domain expires.
+ *The type of workflow. The only supported value is APPFLOW_INTEGRATION.
*/ - DefaultExpirationDays: number | undefined; + WorkflowType: WorkflowType | string | undefined; /** - *The default encryption key, which is an AWS managed key, is used when no specific type - * of encryption key is specified. It is used to encrypt all data before it is placed in - * permanent or semi-permanent storage.
+ *Configuration data for integration workflow.
*/ - DefaultEncryptionKey?: string; + IntegrationConfig: IntegrationConfig | undefined; /** - *The URL of the SQS dead letter queue, which is used for reporting errors associated with - * ingesting data from third party applications.
+ *The name of the profile object type.
*/ - DeadLetterQueueUrl?: string; + ObjectTypeName: string | undefined; /** - *The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly
- * batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every
- * Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the
- * GetMatches
- * API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from
- * S3.
The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.
*/ - Matching?: MatchingResponse; + RoleArn: string | undefined; /** - *The timestamp of when the domain was created.
+ *The tags used to organize, track, or control access for this resource.
*/ - CreatedAt: Date | undefined; + Tags?: { [key: string]: string }; +} +export namespace CreateIntegrationWorkflowRequest { /** - *The timestamp of when the domain was most recently edited.
+ * @internal */ - LastUpdatedAt: Date | undefined; + export const filterSensitiveLog = (obj: CreateIntegrationWorkflowRequest): any => ({ + ...obj, + }); +} +export interface CreateIntegrationWorkflowResponse { /** - *The tags used to organize, track, or control access for this resource.
+ *Unique identifier for the workflow.
*/ - Tags?: { [key: string]: string }; + WorkflowId: string | undefined; + + /** + *A message indicating create request was received.
+ */ + Message: string | undefined; } -export namespace CreateDomainResponse { +export namespace CreateIntegrationWorkflowResponse { /** * @internal */ - export const filterSensitiveLog = (obj: CreateDomainResponse): any => ({ + export const filterSensitiveLog = (obj: CreateIntegrationWorkflowResponse): any => ({ ...obj, }); } @@ -1119,6 +1825,38 @@ export namespace DeleteProfileObjectTypeResponse { }); } +export interface DeleteWorkflowRequest { + /** + *The unique name of the domain.
+ */ + DomainName: string | undefined; + + /** + *Unique identifier for the workflow.
+ */ + WorkflowId: string | undefined; +} + +export namespace DeleteWorkflowRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteWorkflowRequest): any => ({ + ...obj, + }); +} + +export interface DeleteWorkflowResponse {} + +export namespace DeleteWorkflowResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteWorkflowResponse): any => ({ + ...obj, + }); +} + export interface GetAutoMergingPreviewRequest { /** *The unique name of the domain.
@@ -1556,6 +2294,11 @@ export interface GetIntegrationResponse { *ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
*/
ObjectTypeNames?: { [key: string]: string };
+
+ /**
+ * Unique identifier for the workflow.
+ */ + WorkflowId?: string; } export namespace GetIntegrationResponse { @@ -1853,445 +2596,255 @@ export namespace GetProfileObjectTypeTemplateRequest { export interface GetProfileObjectTypeTemplateResponse { /** - *A unique identifier for the object template.
- */ - TemplateId?: string; - - /** - *The name of the source of the object template.
- */ - SourceName?: string; - - /** - *The source of the object template.
- */ - SourceObject?: string; - - /** - *Indicates whether a profile should be created when data is received if one doesn’t exist
- * for an object of this type. The default is FALSE. If the AllowProfileCreation
- * flag is set to FALSE, then the service tries to fetch a standard profile and
- * associate this object with the profile. If it is set to TRUE, and if no match
- * is found, then the service creates a new standard profile.
The format of your sourceLastUpdatedTimestamp that was previously set
- * up.
A map of the name and ObjectType field.
- */ - Fields?: { [key: string]: ObjectTypeField }; - - /** - *A list of unique keys that can be used to map data to the profile.
- */ - Keys?: { [key: string]: ObjectTypeKey[] }; -} - -export namespace GetProfileObjectTypeTemplateResponse { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetProfileObjectTypeTemplateResponse): any => ({ - ...obj, - }); -} - -export interface ListAccountIntegrationsRequest { - /** - *The URI of the S3 bucket or any other type of data source.
- */ - Uri: string | undefined; - - /** - *The pagination token from the previous ListAccountIntegrations API call.
- */ - NextToken?: string; - - /** - *The maximum number of objects returned per page.
- */ - MaxResults?: number; -} - -export namespace ListAccountIntegrationsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ListAccountIntegrationsRequest): any => ({ - ...obj, - }); -} - -/** - *An integration in list of integrations.
- */ -export interface ListIntegrationItem { - /** - *The unique name of the domain.
- */ - DomainName: string | undefined; - - /** - *The URI of the S3 bucket or any other type of data source.
- */ - Uri: string | undefined; - - /** - *The name of the profile object type.
- */ - ObjectTypeName?: string; - - /** - *The timestamp of when the domain was created.
- */ - CreatedAt: Date | undefined; - - /** - *The timestamp of when the domain was most recently edited.
- */ - LastUpdatedAt: Date | undefined; - - /** - *The tags used to organize, track, or control access for this resource.
- */ - Tags?: { [key: string]: string }; - - /** - *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.
The list of ListAccountIntegration instances.
- */ - Items?: ListIntegrationItem[]; - - /** - *The pagination token from the previous ListAccountIntegrations API call.
- */ - NextToken?: string; -} - -export namespace ListAccountIntegrationsResponse { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ListAccountIntegrationsResponse): any => ({ - ...obj, - }); -} - -export interface ListDomainsRequest { - /** - *The pagination token from the previous ListDomain API call.
- */ - NextToken?: string; - - /** - *The maximum number of objects returned per page.
- */ - MaxResults?: number; -} - -export namespace ListDomainsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ListDomainsRequest): any => ({ - ...obj, - }); -} - -/** - *An object in a list that represents a domain.
- */ -export interface ListDomainItem { - /** - *The unique name of the domain.
+ *A unique identifier for the object template.
*/ - DomainName: string | undefined; + TemplateId?: string; /** - *The timestamp of when the domain was created.
+ *The name of the source of the object template.
*/ - CreatedAt: Date | undefined; + SourceName?: string; /** - *The timestamp of when the domain was most recently edited.
+ *The source of the object template.
*/ - LastUpdatedAt: Date | undefined; + SourceObject?: string; /** - *The tags used to organize, track, or control access for this resource.
+ *Indicates whether a profile should be created when data is received if one doesn’t exist
+ * for an object of this type. The default is FALSE. If the AllowProfileCreation
+ * flag is set to FALSE, then the service tries to fetch a standard profile and
+ * associate this object with the profile. If it is set to TRUE, and if no match
+ * is found, then the service creates a new standard profile.
The format of your sourceLastUpdatedTimestamp that was previously set
+ * up.
The list of ListDomains instances.
+ *A map of the name and ObjectType field.
*/ - Items?: ListDomainItem[]; + Fields?: { [key: string]: ObjectTypeField }; /** - *The pagination token from the previous ListDomains API call.
+ *A list of unique keys that can be used to map data to the profile.
*/ - NextToken?: string; + Keys?: { [key: string]: ObjectTypeKey[] }; } -export namespace ListDomainsResponse { +export namespace GetProfileObjectTypeTemplateResponse { /** * @internal */ - export const filterSensitiveLog = (obj: ListDomainsResponse): any => ({ + export const filterSensitiveLog = (obj: GetProfileObjectTypeTemplateResponse): any => ({ ...obj, }); } -export interface ListIdentityResolutionJobsRequest { +export interface GetWorkflowRequest { /** *The unique name of the domain.
*/ DomainName: string | undefined; /** - *The token for the next set of results. Use the value returned in the previous - * response in the next request to retrieve the next set of results.
- */ - NextToken?: string; - - /** - *The maximum number of results to return per page.
+ *Unique identifier for the workflow.
*/ - MaxResults?: number; + WorkflowId: string | undefined; } -export namespace ListIdentityResolutionJobsRequest { +export namespace GetWorkflowRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ListIdentityResolutionJobsRequest): any => ({ + export const filterSensitiveLog = (obj: GetWorkflowRequest): any => ({ ...obj, }); } /** - *Information about the Identity Resolution Job.
+ *Structure to hold workflow attributes.
*/ -export interface IdentityResolutionJob { +export interface WorkflowAttributes { /** - *The unique name of the domain.
+ *Workflow attributes specific to APPFLOW_INTEGRATION workflow.
The unique identifier of the Identity Resolution Job.
+ * @internal */ - JobId?: string; + export const filterSensitiveLog = (obj: WorkflowAttributes): any => ({ + ...obj, + }); +} +/** + *Generic object containing workflow execution metrics.
+ */ +export interface WorkflowMetrics { /** - *The status of the Identity Resolution Job.
- *
- * PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn
- * off the Identity Resolution feature in your domain, jobs in the PENDING state are
- * deleted.
- * PREPROCESSING: The Identity Resolution Job is loading your data.
- * FIND_MATCHING: The Identity Resolution Job is using the machine learning model to
- * identify profiles that belong to the same matching group.
- * MERGING: The Identity Resolution Job is merging duplicate profiles.
- * COMPLETED: The Identity Resolution Job completed successfully.
- * PARTIAL_SUCCESS: There's a system error and not all of the data is
- * merged. The Identity Resolution Job writes a message indicating the source of the problem.
- * FAILED: The Identity Resolution Job did not merge any data. It writes a message
- * indicating the source of the problem.
Workflow execution metrics for APPFLOW_INTEGRATION workflow.
The timestamp of when the job was started or will be started.
+ * @internal */ - JobStartTime?: Date; + export const filterSensitiveLog = (obj: WorkflowMetrics): any => ({ + ...obj, + }); +} +export interface GetWorkflowResponse { /** - *The timestamp of when the job was completed.
+ *Unique identifier for the workflow.
*/ - JobEndTime?: Date; + WorkflowId?: string; /** - *Statistics about an Identity Resolution Job.
+ *The type of workflow. The only supported value is APPFLOW_INTEGRATION.
*/ - JobStats?: JobStats; + WorkflowType?: WorkflowType | string; /** - *The S3 location where the Identity Resolution Job writes result files.
+ *Status of workflow execution.
*/ - ExportingLocation?: ExportingLocation; + Status?: Status | string; /** - *The error messages that are generated when the Identity Resolution Job runs.
+ *Workflow error messages during execution (if any).
*/ - Message?: string; -} + ErrorDescription?: string; -export namespace IdentityResolutionJob { /** - * @internal + *The timestamp that represents when workflow execution started.
*/ - export const filterSensitiveLog = (obj: IdentityResolutionJob): any => ({ - ...obj, - }); -} + StartDate?: Date; -export interface ListIdentityResolutionJobsResponse { /** - *A list of Identity Resolution Jobs.
+ *The timestamp that represents when workflow execution last updated.
*/ - IdentityResolutionJobsList?: IdentityResolutionJob[]; + LastUpdatedAt?: Date; /** - *If there are additional results, this is the token for the next set of results.
+ *Attributes provided for workflow execution.
*/ - NextToken?: string; + Attributes?: WorkflowAttributes; + + /** + *Workflow specific execution metrics.
+ */ + Metrics?: WorkflowMetrics; } -export namespace ListIdentityResolutionJobsResponse { +export namespace GetWorkflowResponse { /** * @internal */ - export const filterSensitiveLog = (obj: ListIdentityResolutionJobsResponse): any => ({ + export const filterSensitiveLog = (obj: GetWorkflowResponse): any => ({ ...obj, }); } -export interface ListIntegrationsRequest { +export interface GetWorkflowStepsRequest { /** *The unique name of the domain.
*/ DomainName: string | undefined; /** - *The pagination token from the previous ListIntegrations API call.
+ *Unique identifier for the workflow.
+ */ + WorkflowId: string | undefined; + + /** + *The token for the next set of results. Use the value returned in the previous + * response in the next request to retrieve the next set of results.
*/ NextToken?: string; /** - *The maximum number of objects returned per page.
+ *The maximum number of results to return per page.
*/ MaxResults?: number; } -export namespace ListIntegrationsRequest { +export namespace GetWorkflowStepsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ListIntegrationsRequest): any => ({ + export const filterSensitiveLog = (obj: GetWorkflowStepsRequest): any => ({ ...obj, }); } -export interface ListIntegrationsResponse { - /** - *The list of ListIntegrations instances.
- */ - Items?: ListIntegrationItem[]; - +/** + *List containing steps in workflow.
+ */ +export interface WorkflowStepItem { /** - *The pagination token from the previous ListIntegrations API call.
+ *Workflow step information specific to APPFLOW_INTEGRATION workflow.
The filter applied to ListProfileObjects response to include profile objects with the - * specified index values. This filter is only supported for ObjectTypeName _asset, _case and - * _order.
- */ -export interface ObjectFilter { +export interface GetWorkflowStepsResponse { /** - *A searchable identifier of a standard profile object. The predefined keys you can use to - * search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can - * use to search for _case include: _caseId. The predefined keys you can use to search for - * _order include: _orderId.
+ *Unique identifier for the workflow.
*/ - KeyName: string | undefined; + WorkflowId?: string; /** - *A list of key values.
+ *The type of workflow. The only supported value is APPFLOW_INTEGRATION.
*/ - Values: string[] | undefined; + WorkflowType?: WorkflowType | string; + + /** + *List containing workflow step details.
+ */ + Items?: WorkflowStepItem[]; + + /** + *If there are additional results, this is the token for the next set of results.
+ */ + NextToken?: string; } -export namespace ObjectFilter { +export namespace GetWorkflowStepsResponse { /** * @internal */ - export const filterSensitiveLog = (obj: ObjectFilter): any => ({ + export const filterSensitiveLog = (obj: GetWorkflowStepsResponse): any => ({ ...obj, }); } -export interface ListProfileObjectsRequest { +export interface ListAccountIntegrationsRequest { /** - *The pagination token from the previous call to ListProfileObjects.
+ *The URI of the S3 bucket or any other type of data source.
+ */ + Uri: string | undefined; + + /** + *The pagination token from the previous ListAccountIntegrations API call.
*/ NextToken?: string; @@ -2300,96 +2853,101 @@ export interface ListProfileObjectsRequest { */ MaxResults?: number; + /** + *Boolean to indicate if hidden integration should be returned. Defaults to False.
An integration in list of integrations.
+ */ +export interface ListIntegrationItem { /** *The unique name of the domain.
*/ DomainName: string | undefined; /** - *The name of the profile object type.
+ *The URI of the S3 bucket or any other type of data source.
*/ - ObjectTypeName: string | undefined; + Uri: string | undefined; /** - *The unique identifier of a customer profile.
+ *The name of the profile object type.
*/ - ProfileId: string | undefined; + ObjectTypeName?: string; /** - *Applies a filter to the response to include profile objects with the specified index - * values. This filter is only supported for ObjectTypeName _asset, _case and _order.
+ *The timestamp of when the domain was created.
*/ - ObjectFilter?: ObjectFilter; -} + CreatedAt: Date | undefined; -export namespace ListProfileObjectsRequest { /** - * @internal + *The timestamp of when the domain was most recently edited.
*/ - export const filterSensitiveLog = (obj: ListProfileObjectsRequest): any => ({ - ...obj, - }); -} + LastUpdatedAt: Date | undefined; -/** - *A ProfileObject in a list of ProfileObjects.
- */ -export interface ListProfileObjectsItem { /** - *Specifies the kind of object being added to a profile, such as - * "Salesforce-Account."
+ *The tags used to organize, track, or control access for this resource.
*/ - ObjectTypeName?: string; + Tags?: { [key: string]: string }; /** - *The unique identifier of the ProfileObject generated by the service.
+ *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.
A JSON representation of a ProfileObject that belongs to a profile.
+ *Unique identifier for the workflow.
*/ - Object?: string; + WorkflowId?: string; } -export namespace ListProfileObjectsItem { +export namespace ListIntegrationItem { /** * @internal */ - export const filterSensitiveLog = (obj: ListProfileObjectsItem): any => ({ + export const filterSensitiveLog = (obj: ListIntegrationItem): any => ({ ...obj, }); } -export interface ListProfileObjectsResponse { +export interface ListAccountIntegrationsResponse { /** - *The list of ListProfileObject instances.
+ *The list of ListAccountIntegration instances.
*/ - Items?: ListProfileObjectsItem[]; + Items?: ListIntegrationItem[]; /** - *The pagination token from the previous call to ListProfileObjects.
+ *The pagination token from the previous ListAccountIntegrations API call.
*/ NextToken?: string; } -export namespace ListProfileObjectsResponse { +export namespace ListAccountIntegrationsResponse { /** * @internal */ - export const filterSensitiveLog = (obj: ListProfileObjectsResponse): any => ({ + export const filterSensitiveLog = (obj: ListAccountIntegrationsResponse): any => ({ ...obj, }); } -export interface ListProfileObjectTypesRequest { - /** - *The unique name of the domain.
- */ - DomainName: string | undefined; - +export interface ListDomainsRequest { /** - *Identifies the next page of results to return.
+ *The pagination token from the previous ListDomain API call.
*/ NextToken?: string; @@ -2399,38 +2957,33 @@ export interface ListProfileObjectTypesRequest { MaxResults?: number; } -export namespace ListProfileObjectTypesRequest { +export namespace ListDomainsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ListProfileObjectTypesRequest): any => ({ + export const filterSensitiveLog = (obj: ListDomainsRequest): any => ({ ...obj, }); } /** - *A ProfileObjectType instance.
+ *An object in a list that represents a domain.
*/ -export interface ListProfileObjectTypeItem { - /** - *The name of the profile object type.
- */ - ObjectTypeName: string | undefined; - +export interface ListDomainItem { /** - *Description of the profile object type.
+ *The unique name of the domain.
*/ - Description: string | undefined; + DomainName: string | undefined; /** *The timestamp of when the domain was created.
*/ - CreatedAt?: Date; + CreatedAt: Date | undefined; /** *The timestamp of when the domain was most recently edited.
*/ - LastUpdatedAt?: Date; + LastUpdatedAt: Date | undefined; /** *The tags used to organize, track, or control access for this resource.
@@ -2438,752 +2991,812 @@ export interface ListProfileObjectTypeItem { Tags?: { [key: string]: string }; } -export namespace ListProfileObjectTypeItem { +export namespace ListDomainItem { /** * @internal */ - export const filterSensitiveLog = (obj: ListProfileObjectTypeItem): any => ({ + export const filterSensitiveLog = (obj: ListDomainItem): any => ({ ...obj, }); } -export interface ListProfileObjectTypesResponse { +export interface ListDomainsResponse { /** - *The list of ListProfileObjectTypes instances.
+ *The list of ListDomains instances.
*/ - Items?: ListProfileObjectTypeItem[]; + Items?: ListDomainItem[]; /** - *Identifies the next page of results to return.
+ *The pagination token from the previous ListDomains API call.
*/ NextToken?: string; } -export namespace ListProfileObjectTypesResponse { +export namespace ListDomainsResponse { /** * @internal */ - export const filterSensitiveLog = (obj: ListProfileObjectTypesResponse): any => ({ + export const filterSensitiveLog = (obj: ListDomainsResponse): any => ({ ...obj, }); } -export interface ListProfileObjectTypeTemplatesRequest { +export interface ListIdentityResolutionJobsRequest { /** - *The pagination token from the previous ListObjectTypeTemplates API call.
+ *The unique name of the domain.
+ */ + DomainName: string | undefined; + + /** + *The token for the next set of results. Use the value returned in the previous + * response in the next request to retrieve the next set of results.
*/ NextToken?: string; /** - *The maximum number of objects returned per page.
+ *The maximum number of results to return per page.
*/ MaxResults?: number; } -export namespace ListProfileObjectTypeTemplatesRequest { +export namespace ListIdentityResolutionJobsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplatesRequest): any => ({ + export const filterSensitiveLog = (obj: ListIdentityResolutionJobsRequest): any => ({ ...obj, }); } /** - *A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
+ *Information about the Identity Resolution Job.
*/ -export interface ListProfileObjectTypeTemplateItem { +export interface IdentityResolutionJob { /** - *A unique identifier for the object template.
+ *The unique name of the domain.
*/ - TemplateId?: string; + DomainName?: string; /** - *The name of the source of the object template.
+ *The unique identifier of the Identity Resolution Job.
*/ - SourceName?: string; + JobId?: string; /** - *The source of the object template.
+ *The status of the Identity Resolution Job.
+ *
+ * PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn
+ * off the Identity Resolution feature in your domain, jobs in the PENDING state are
+ * deleted.
+ * PREPROCESSING: The Identity Resolution Job is loading your data.
+ * FIND_MATCHING: The Identity Resolution Job is using the machine learning model to
+ * identify profiles that belong to the same matching group.
+ * MERGING: The Identity Resolution Job is merging duplicate profiles.
+ * COMPLETED: The Identity Resolution Job completed successfully.
+ * PARTIAL_SUCCESS: There's a system error and not all of the data is
+ * merged. The Identity Resolution Job writes a message indicating the source of the problem.
+ * FAILED: The Identity Resolution Job did not merge any data. It writes a message
+ * indicating the source of the problem.
The timestamp of when the job was started or will be started.
*/ - export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplateItem): any => ({ - ...obj, - }); -} + JobStartTime?: Date; -export interface ListProfileObjectTypeTemplatesResponse { /** - *The list of ListProfileObjectType template instances.
+ *The timestamp of when the job was completed.
*/ - Items?: ListProfileObjectTypeTemplateItem[]; + JobEndTime?: Date; /** - *The pagination token from the previous ListObjectTypeTemplates API call.
+ *Statistics about an Identity Resolution Job.
*/ - NextToken?: string; -} + JobStats?: JobStats; -export namespace ListProfileObjectTypeTemplatesResponse { /** - * @internal + *The S3 location where the Identity Resolution Job writes result files.
*/ - export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplatesResponse): any => ({ - ...obj, - }); -} + ExportingLocation?: ExportingLocation; -export interface ListTagsForResourceRequest { /** - *The ARN of the resource for which you want to view tags.
+ *The error messages that are generated when the Identity Resolution Job runs.
*/ - resourceArn: string | undefined; + Message?: string; } -export namespace ListTagsForResourceRequest { +export namespace IdentityResolutionJob { /** * @internal */ - export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ + export const filterSensitiveLog = (obj: IdentityResolutionJob): any => ({ ...obj, }); } -export interface ListTagsForResourceResponse { +export interface ListIdentityResolutionJobsResponse { /** - *The tags used to organize, track, or control access for this resource.
+ *A list of Identity Resolution Jobs.
*/ - tags?: { [key: string]: string }; + IdentityResolutionJobsList?: IdentityResolutionJob[]; + + /** + *If there are additional results, this is the token for the next set of results.
+ */ + NextToken?: string; } -export namespace ListTagsForResourceResponse { +export namespace ListIdentityResolutionJobsResponse { /** * @internal */ - export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ + export const filterSensitiveLog = (obj: ListIdentityResolutionJobsResponse): any => ({ ...obj, }); } -/** - *A duplicate customer profile that is to be merged into a main profile.
- */ -export interface FieldSourceProfileIds { +export interface ListIntegrationsRequest { /** - *A unique identifier for the account number field to be merged.
+ *The unique name of the domain.
*/ - AccountNumber?: string; + DomainName: string | undefined; /** - *A unique identifier for the additional information field to be merged.
+ *The pagination token from the previous ListIntegrations API call.
*/ - AdditionalInformation?: string; + NextToken?: string; /** - *A unique identifier for the party type field to be merged.
+ *The maximum number of objects returned per page.
*/ - PartyType?: string; + MaxResults?: number; /** - *A unique identifier for the business name field to be merged.
+ *Boolean to indicate if hidden integration should be returned. Defaults to False.
A unique identifier for the first name field to be merged.
+ *The list of ListIntegrations instances.
*/ - FirstName?: string; + Items?: ListIntegrationItem[]; /** - *A unique identifier for the middle name field to be merged.
+ *The pagination token from the previous ListIntegrations API call.
*/ - MiddleName?: string; + NextToken?: string; +} +export namespace ListIntegrationsResponse { /** - *A unique identifier for the last name field to be merged.
+ * @internal */ - LastName?: string; + export const filterSensitiveLog = (obj: ListIntegrationsResponse): any => ({ + ...obj, + }); +} + +/** + *The filter applied to ListProfileObjects response to include profile objects with the + * specified index values. This filter is only supported for ObjectTypeName _asset, _case and + * _order.
+ */ +export interface ObjectFilter { + /** + *A searchable identifier of a standard profile object. The predefined keys you can use to + * search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can + * use to search for _case include: _caseId. The predefined keys you can use to search for + * _order include: _orderId.
+ */ + KeyName: string | undefined; /** - *A unique identifier for the birthdate field to be merged.
+ *A list of key values.
*/ - BirthDate?: string; + Values: string[] | undefined; +} +export namespace ObjectFilter { /** - *A unique identifier for the gender field to be merged.
+ * @internal */ - Gender?: string; + export const filterSensitiveLog = (obj: ObjectFilter): any => ({ + ...obj, + }); +} +export interface ListProfileObjectsRequest { /** - *A unique identifier for the phone number field to be merged.
+ *The pagination token from the previous call to ListProfileObjects.
*/ - PhoneNumber?: string; + NextToken?: string; /** - *A unique identifier for the mobile phone number field to be merged.
+ *The maximum number of objects returned per page.
+ */ + MaxResults?: number; + + /** + *The unique name of the domain.
*/ - MobilePhoneNumber?: string; + DomainName: string | undefined; /** - *A unique identifier for the home phone number field to be merged.
+ *The name of the profile object type.
*/ - HomePhoneNumber?: string; + ObjectTypeName: string | undefined; /** - *A unique identifier for the business phone number field to be merged.
+ *The unique identifier of a customer profile.
*/ - BusinessPhoneNumber?: string; + ProfileId: string | undefined; /** - *A unique identifier for the email address field to be merged.
+ *Applies a filter to the response to include profile objects with the specified index + * values. This filter is only supported for ObjectTypeName _asset, _case and _order.
*/ - EmailAddress?: string; + ObjectFilter?: ObjectFilter; +} +export namespace ListProfileObjectsRequest { /** - *A unique identifier for the personal email address field to be merged.
+ * @internal */ - PersonalEmailAddress?: string; + export const filterSensitiveLog = (obj: ListProfileObjectsRequest): any => ({ + ...obj, + }); +} +/** + *A ProfileObject in a list of ProfileObjects.
+ */ +export interface ListProfileObjectsItem { /** - *A unique identifier for the party type field to be merged.
+ *Specifies the kind of object being added to a profile, such as + * "Salesforce-Account."
*/ - BusinessEmailAddress?: string; + ObjectTypeName?: string; /** - *A unique identifier for the party type field to be merged.
+ *The unique identifier of the ProfileObject generated by the service.
*/ - Address?: string; + ProfileObjectUniqueKey?: string; /** - *A unique identifier for the shipping address field to be merged.
+ *A JSON representation of a ProfileObject that belongs to a profile.
*/ - ShippingAddress?: string; + Object?: string; +} +export namespace ListProfileObjectsItem { /** - *A unique identifier for the mailing address field to be merged.
+ * @internal */ - MailingAddress?: string; + export const filterSensitiveLog = (obj: ListProfileObjectsItem): any => ({ + ...obj, + }); +} +export interface ListProfileObjectsResponse { /** - *A unique identifier for the billing type field to be merged.
+ *The list of ListProfileObject instances.
*/ - BillingAddress?: string; + Items?: ListProfileObjectsItem[]; /** - *A unique identifier for the attributes field to be merged.
+ *The pagination token from the previous call to ListProfileObjects.
*/ - Attributes?: { [key: string]: string }; + NextToken?: string; } -export namespace FieldSourceProfileIds { +export namespace ListProfileObjectsResponse { /** * @internal */ - export const filterSensitiveLog = (obj: FieldSourceProfileIds): any => ({ + export const filterSensitiveLog = (obj: ListProfileObjectsResponse): any => ({ ...obj, }); } -export interface MergeProfilesRequest { +export interface ListProfileObjectTypesRequest { /** *The unique name of the domain.
*/ DomainName: string | undefined; /** - *The identifier of the profile to be taken.
- */ - MainProfileId: string | undefined; - - /** - *The identifier of the profile to be merged into MainProfileId.
+ *Identifies the next page of results to return.
*/ - ProfileIdsToBeMerged: string[] | undefined; + NextToken?: string; /** - *The identifiers of the fields in the profile that has the information you want to apply - * to the merge. For example, say you want to merge EmailAddress from Profile1 into - * MainProfile. This would be the identifier of the EmailAddress field in Profile1.
+ *The maximum number of objects returned per page.
*/ - FieldSourceProfileIds?: FieldSourceProfileIds; + MaxResults?: number; } -export namespace MergeProfilesRequest { +export namespace ListProfileObjectTypesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: MergeProfilesRequest): any => ({ + export const filterSensitiveLog = (obj: ListProfileObjectTypesRequest): any => ({ ...obj, }); } -export interface MergeProfilesResponse { +/** + *A ProfileObjectType instance.
+ */ +export interface ListProfileObjectTypeItem { /** - *A message that indicates the merge request is complete.
+ *The name of the profile object type.
*/ - Message?: string; + ObjectTypeName: string | undefined; + + /** + *Description of the profile object type.
+ */ + Description: string | undefined; + + /** + *The timestamp of when the domain was created.
+ */ + CreatedAt?: Date; + + /** + *The timestamp of when the domain was most recently edited.
+ */ + LastUpdatedAt?: Date; + + /** + *The tags used to organize, track, or control access for this resource.
+ */ + Tags?: { [key: string]: string }; } -export namespace MergeProfilesResponse { +export namespace ListProfileObjectTypeItem { /** * @internal */ - export const filterSensitiveLog = (obj: MergeProfilesResponse): any => ({ + export const filterSensitiveLog = (obj: ListProfileObjectTypeItem): any => ({ ...obj, }); } -export enum SourceConnectorType { - MARKETO = "Marketo", - S3 = "S3", - SALESFORCE = "Salesforce", - SERVICENOW = "Servicenow", - ZENDESK = "Zendesk", -} +export interface ListProfileObjectTypesResponse { + /** + *The list of ListProfileObjectTypes instances.
+ */ + Items?: ListProfileObjectTypeItem[]; -/** - *Specifies the configuration used when importing incremental records from the - * source.
- */ -export interface IncrementalPullConfig { /** - *A field that specifies the date time or timestamp field as the criteria to use when - * importing incremental records from the source.
+ *Identifies the next page of results to return.
*/ - DatetimeTypeFieldName?: string; + NextToken?: string; } -export namespace IncrementalPullConfig { +export namespace ListProfileObjectTypesResponse { /** * @internal */ - export const filterSensitiveLog = (obj: IncrementalPullConfig): any => ({ + export const filterSensitiveLog = (obj: ListProfileObjectTypesResponse): any => ({ ...obj, }); } -/** - *The properties that are applied when Marketo is being used as a source.
- */ -export interface MarketoSourceProperties { +export interface ListProfileObjectTypeTemplatesRequest { /** - *The object specified in the Marketo flow source.
+ *The pagination token from the previous ListObjectTypeTemplates API call.
*/ - Object: string | undefined; + NextToken?: string; + + /** + *The maximum number of objects returned per page.
+ */ + MaxResults?: number; } -export namespace MarketoSourceProperties { +export namespace ListProfileObjectTypeTemplatesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: MarketoSourceProperties): any => ({ + export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplatesRequest): any => ({ ...obj, }); } /** - *The properties that are applied when Amazon S3 is being used as the flow source.
+ *A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
*/ -export interface S3SourceProperties { +export interface ListProfileObjectTypeTemplateItem { /** - *The Amazon S3 bucket name where the source files are stored.
+ *A unique identifier for the object template.
*/ - BucketName: string | undefined; + TemplateId?: string; /** - *The object key for the Amazon S3 bucket in which the source files are stored.
+ *The name of the source of the object template.
*/ - BucketPrefix?: string; + SourceName?: string; + + /** + *The source of the object template.
+ */ + SourceObject?: string; } -export namespace S3SourceProperties { +export namespace ListProfileObjectTypeTemplateItem { /** * @internal */ - export const filterSensitiveLog = (obj: S3SourceProperties): any => ({ + export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplateItem): any => ({ ...obj, }); } -/** - *The properties that are applied when Salesforce is being used as a source.
- */ -export interface SalesforceSourceProperties { - /** - *The object specified in the Salesforce flow source.
- */ - Object: string | undefined; - +export interface ListProfileObjectTypeTemplatesResponse { /** - *The flag that enables dynamic fetching of new (recently added) fields in the Salesforce - * objects while running a flow.
+ *The list of ListProfileObjectType template instances.
*/ - EnableDynamicFieldUpdate?: boolean; + Items?: ListProfileObjectTypeTemplateItem[]; /** - *Indicates whether Amazon AppFlow includes deleted files in the flow run.
+ *The pagination token from the previous ListObjectTypeTemplates API call.
*/ - IncludeDeletedRecords?: boolean; + NextToken?: string; } -export namespace SalesforceSourceProperties { +export namespace ListProfileObjectTypeTemplatesResponse { /** * @internal */ - export const filterSensitiveLog = (obj: SalesforceSourceProperties): any => ({ + export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplatesResponse): any => ({ ...obj, }); } -/** - *The properties that are applied when ServiceNow is being used as a source.
- */ -export interface ServiceNowSourceProperties { +export interface ListTagsForResourceRequest { /** - *The object specified in the ServiceNow flow source.
+ *The ARN of the resource for which you want to view tags.
*/ - Object: string | undefined; + resourceArn: string | undefined; } -export namespace ServiceNowSourceProperties { +export namespace ListTagsForResourceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ServiceNowSourceProperties): any => ({ + export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); } -/** - *The properties that are applied when using Zendesk as a flow source.
- */ -export interface ZendeskSourceProperties { +export interface ListTagsForResourceResponse { /** - *The object specified in the Zendesk flow source.
+ *The tags used to organize, track, or control access for this resource.
*/ - Object: string | undefined; + tags?: { [key: string]: string }; } -export namespace ZendeskSourceProperties { +export namespace ListTagsForResourceResponse { /** * @internal */ - export const filterSensitiveLog = (obj: ZendeskSourceProperties): any => ({ + export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); } -/** - *Specifies the information that is required to query a particular Amazon AppFlow connector. - * Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.
- */ -export interface SourceConnectorProperties { +export interface ListWorkflowsRequest { /** - *The properties that are applied when Marketo is being used as a source.
+ *The unique name of the domain.
*/ - Marketo?: MarketoSourceProperties; + DomainName: string | undefined; /** - *The properties that are applied when Amazon S3 is being used as the flow source.
+ *The type of workflow. The only supported value is APPFLOW_INTEGRATION.
*/ - S3?: S3SourceProperties; + WorkflowType?: WorkflowType | string; /** - *The properties that are applied when Salesforce is being used as a source.
+ *Status of workflow execution.
*/ - Salesforce?: SalesforceSourceProperties; + Status?: Status | string; /** - *The properties that are applied when ServiceNow is being used as a source.
+ *Retrieve workflows started after timestamp.
*/ - ServiceNow?: ServiceNowSourceProperties; + QueryStartDate?: Date; + + /** + *Retrieve workflows ended after timestamp.
+ */ + QueryEndDate?: Date; + + /** + *The token for the next set of results. Use the value returned in the previous + * response in the next request to retrieve the next set of results.
+ */ + NextToken?: string; /** - *The properties that are applied when using Zendesk as a flow source.
+ *The maximum number of results to return per page.
*/ - Zendesk?: ZendeskSourceProperties; + MaxResults?: number; } -export namespace SourceConnectorProperties { +export namespace ListWorkflowsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: SourceConnectorProperties): any => ({ + export const filterSensitiveLog = (obj: ListWorkflowsRequest): any => ({ ...obj, }); } /** - *Contains information about the configuration of the source connector used in the - * flow.
+ *A workflow in list of workflows.
*/ -export interface SourceFlowConfig { +export interface ListWorkflowsItem { /** - *The name of the AppFlow connector profile. This name must be unique for each connector - * profile in the AWS account.
+ *The type of workflow. The only supported value is APPFLOW_INTEGRATION.
*/ - ConnectorProfileName?: string; + WorkflowType: WorkflowType | string | undefined; /** - *The type of connector, such as Salesforce, Marketo, and so on.
+ *Unique identifier for the workflow.
*/ - ConnectorType: SourceConnectorType | string | undefined; + WorkflowId: string | undefined; /** - *Defines the configuration for a scheduled incremental data pull. If a valid - * configuration is provided, the fields specified in the configuration are used when querying - * for the incremental data pull.
+ *Status of workflow execution.
*/ - IncrementalPullConfig?: IncrementalPullConfig; + Status: Status | string | undefined; /** - *Specifies the information that is required to query a particular source - * connector.
+ *Description for workflow execution status.
*/ - SourceConnectorProperties: SourceConnectorProperties | undefined; + StatusDescription: string | undefined; + + /** + *Creation timestamp for workflow.
+ */ + CreatedAt: Date | undefined; + + /** + *Last updated timestamp for workflow.
+ */ + LastUpdatedAt: Date | undefined; } -export namespace SourceFlowConfig { +export namespace ListWorkflowsItem { /** * @internal */ - export const filterSensitiveLog = (obj: SourceFlowConfig): any => ({ + export const filterSensitiveLog = (obj: ListWorkflowsItem): any => ({ ...obj, }); } -export enum OperatorPropertiesKeys { - CONCAT_FORMAT = "CONCAT_FORMAT", - DATA_TYPE = "DATA_TYPE", - DESTINATION_DATA_TYPE = "DESTINATION_DATA_TYPE", - LOWER_BOUND = "LOWER_BOUND", - MASK_LENGTH = "MASK_LENGTH", - MASK_VALUE = "MASK_VALUE", - MATH_OPERATION_FIELDS_ORDER = "MATH_OPERATION_FIELDS_ORDER", - SOURCE_DATA_TYPE = "SOURCE_DATA_TYPE", - SUBFIELD_CATEGORY_MAP = "SUBFIELD_CATEGORY_MAP", - TRUNCATE_LENGTH = "TRUNCATE_LENGTH", - UPPER_BOUND = "UPPER_BOUND", - VALIDATION_ACTION = "VALIDATION_ACTION", - VALUE = "VALUE", - VALUES = "VALUES", +export interface ListWorkflowsResponse { + /** + *List containing workflow details.
+ */ + Items?: ListWorkflowsItem[]; + + /** + *If there are additional results, this is the token for the next set of results.
+ */ + NextToken?: string; } -export enum TaskType { - ARITHMETIC = "Arithmetic", - FILTER = "Filter", - MAP = "Map", - MASK = "Mask", - MERGE = "Merge", - TRUNCATE = "Truncate", - VALIDATE = "Validate", +export namespace ListWorkflowsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListWorkflowsResponse): any => ({ + ...obj, + }); } /** - *A class for modeling different type of tasks. Task implementation varies based on the - * TaskType.
+ *A duplicate customer profile that is to be merged into a main profile.
*/ -export interface Task { +export interface FieldSourceProfileIds { /** - *The operation to be performed on the provided source fields.
+ *A unique identifier for the account number field to be merged.
*/ - ConnectorOperator?: ConnectorOperator; + AccountNumber?: string; /** - *A field in a destination connector, or a field value against which Amazon AppFlow validates a - * source field.
+ *A unique identifier for the additional information field to be merged.
*/ - DestinationField?: string; + AdditionalInformation?: string; /** - *The source fields to which a particular task is applied.
+ *A unique identifier for the party type field to be merged.
*/ - SourceFields: string[] | undefined; + PartyType?: string; /** - *A map used to store task-related information. The service looks for particular - * information based on the TaskType.
+ *A unique identifier for the business name field to be merged.
*/ - TaskProperties?: { [key: string]: string }; + BusinessName?: string; /** - *Specifies the particular task implementation that Amazon AppFlow performs.
+ *A unique identifier for the first name field to be merged.
*/ - TaskType: TaskType | string | undefined; -} + FirstName?: string; -export namespace Task { /** - * @internal + *A unique identifier for the middle name field to be merged.
*/ - export const filterSensitiveLog = (obj: Task): any => ({ - ...obj, - }); -} + MiddleName?: string; -export enum DataPullMode { - COMPLETE = "Complete", - INCREMENTAL = "Incremental", -} + /** + *A unique identifier for the last name field to be merged.
+ */ + LastName?: string; -/** - *Specifies the configuration details of a scheduled-trigger flow that you define. - * Currently, these settings only apply to the scheduled-trigger type.
- */ -export interface ScheduledTriggerProperties { /** - *The scheduling expression that determines the rate at which the schedule will run, for - * example rate (5 minutes).
+ *A unique identifier for the birthdate field to be merged.
*/ - ScheduleExpression: string | undefined; + BirthDate?: string; /** - *Specifies whether a scheduled flow has an incremental data transfer or a complete data - * transfer for each flow run.
+ *A unique identifier for the gender field to be merged.
*/ - DataPullMode?: DataPullMode | string; + Gender?: string; /** - *Specifies the scheduled start time for a scheduled-trigger flow.
+ *A unique identifier for the phone number field to be merged.
*/ - ScheduleStartTime?: Date; + PhoneNumber?: string; /** - *Specifies the scheduled end time for a scheduled-trigger flow.
+ *A unique identifier for the mobile phone number field to be merged.
*/ - ScheduleEndTime?: Date; + MobilePhoneNumber?: string; /** - *Specifies the time zone used when referring to the date and time of a - * scheduled-triggered flow, such as America/New_York.
+ *A unique identifier for the home phone number field to be merged.
*/ - Timezone?: string; + HomePhoneNumber?: string; /** - *Specifies the optional offset that is added to the time interval for a - * schedule-triggered flow.
+ *A unique identifier for the business phone number field to be merged.
*/ - ScheduleOffset?: number; + BusinessPhoneNumber?: string; /** - *Specifies the date range for the records to import from the connector in the first flow - * run.
+ *A unique identifier for the email address field to be merged.
*/ - FirstExecutionFrom?: Date; -} + EmailAddress?: string; -export namespace ScheduledTriggerProperties { /** - * @internal + *A unique identifier for the personal email address field to be merged.
*/ - export const filterSensitiveLog = (obj: ScheduledTriggerProperties): any => ({ - ...obj, - }); -} + PersonalEmailAddress?: string; -/** - *Specifies the configuration details that control the trigger for a flow. Currently, - * these settings only apply to the Scheduled trigger type.
- */ -export interface TriggerProperties { /** - *Specifies the configuration details of a schedule-triggered flow that you define.
+ *A unique identifier for the party type field to be merged.
*/ - Scheduled?: ScheduledTriggerProperties; -} + BusinessEmailAddress?: string; -export namespace TriggerProperties { /** - * @internal + *A unique identifier for the party type field to be merged.
*/ - export const filterSensitiveLog = (obj: TriggerProperties): any => ({ - ...obj, - }); -} + Address?: string; -export enum TriggerType { - EVENT = "Event", - ONDEMAND = "OnDemand", - SCHEDULED = "Scheduled", -} + /** + *A unique identifier for the shipping address field to be merged.
+ */ + ShippingAddress?: string; -/** - *The trigger settings that determine how and when Amazon AppFlow runs the specified - * flow.
- */ -export interface TriggerConfig { /** - *Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
+ *A unique identifier for the mailing address field to be merged.
*/ - TriggerType: TriggerType | string | undefined; + MailingAddress?: string; /** - *Specifies the configuration details of a schedule-triggered flow that you define. - * Currently, these settings only apply to the Scheduled trigger type.
+ *A unique identifier for the billing type field to be merged.
*/ - TriggerProperties?: TriggerProperties; + BillingAddress?: string; + + /** + *A unique identifier for the attributes field to be merged.
+ */ + Attributes?: { [key: string]: string }; } -export namespace TriggerConfig { +export namespace FieldSourceProfileIds { /** * @internal */ - export const filterSensitiveLog = (obj: TriggerConfig): any => ({ + export const filterSensitiveLog = (obj: FieldSourceProfileIds): any => ({ ...obj, }); } -/** - *The configurations that control how Customer Profiles retrieves data from the source, - * Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of - * customers.
- */ -export interface FlowDefinition { +export interface MergeProfilesRequest { /** - *A description of the flow you want to create.
+ *The unique name of the domain.
*/ - Description?: string; + DomainName: string | undefined; /** - *The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not - * allowed.
+ *The identifier of the profile to be taken.
*/ - FlowName: string | undefined; + MainProfileId: string | undefined; /** - *The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
+ *The identifier of the profile to be merged into MainProfileId.
*/ - KmsArn: string | undefined; + ProfileIdsToBeMerged: string[] | undefined; /** - *The configuration that controls how Customer Profiles retrieves data from the - * source.
+ *The identifiers of the fields in the profile that has the information you want to apply + * to the merge. For example, say you want to merge EmailAddress from Profile1 into + * MainProfile. This would be the identifier of the EmailAddress field in Profile1.
*/ - SourceFlowConfig: SourceFlowConfig | undefined; + FieldSourceProfileIds?: FieldSourceProfileIds; +} +export namespace MergeProfilesRequest { /** - *A list of tasks that Customer Profiles performs while transferring the data in the flow - * run.
+ * @internal */ - Tasks: Task[] | undefined; + export const filterSensitiveLog = (obj: MergeProfilesRequest): any => ({ + ...obj, + }); +} +export interface MergeProfilesResponse { /** - *The trigger settings that determine how and when the flow runs.
+ *A message that indicates the merge request is complete.
*/ - TriggerConfig: TriggerConfig | undefined; + Message?: string; } -export namespace FlowDefinition { +export namespace MergeProfilesResponse { /** * @internal */ - export const filterSensitiveLog = (obj: FlowDefinition): any => ({ + export const filterSensitiveLog = (obj: MergeProfilesResponse): any => ({ ...obj, }); } @@ -3269,6 +3882,11 @@ export interface PutIntegrationResponse { *ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
*/
ObjectTypeNames?: { [key: string]: string };
+
+ /**
+ * Unique identifier for the workflow.
+ */ + WorkflowId?: string; } export namespace PutIntegrationResponse { diff --git a/clients/client-customer-profiles/src/protocols/Aws_restJson1.ts b/clients/client-customer-profiles/src/protocols/Aws_restJson1.ts index 0c587a6a9980..11fd68986dd4 100644 --- a/clients/client-customer-profiles/src/protocols/Aws_restJson1.ts +++ b/clients/client-customer-profiles/src/protocols/Aws_restJson1.ts @@ -20,6 +20,10 @@ import { import { AddProfileKeyCommandInput, AddProfileKeyCommandOutput } from "../commands/AddProfileKeyCommand"; import { CreateDomainCommandInput, CreateDomainCommandOutput } from "../commands/CreateDomainCommand"; +import { + CreateIntegrationWorkflowCommandInput, + CreateIntegrationWorkflowCommandOutput, +} from "../commands/CreateIntegrationWorkflowCommand"; import { CreateProfileCommandInput, CreateProfileCommandOutput } from "../commands/CreateProfileCommand"; import { DeleteDomainCommandInput, DeleteDomainCommandOutput } from "../commands/DeleteDomainCommand"; import { DeleteIntegrationCommandInput, DeleteIntegrationCommandOutput } from "../commands/DeleteIntegrationCommand"; @@ -33,6 +37,7 @@ import { DeleteProfileObjectTypeCommandInput, DeleteProfileObjectTypeCommandOutput, } from "../commands/DeleteProfileObjectTypeCommand"; +import { DeleteWorkflowCommandInput, DeleteWorkflowCommandOutput } from "../commands/DeleteWorkflowCommand"; import { GetAutoMergingPreviewCommandInput, GetAutoMergingPreviewCommandOutput, @@ -52,6 +57,8 @@ import { GetProfileObjectTypeTemplateCommandInput, GetProfileObjectTypeTemplateCommandOutput, } from "../commands/GetProfileObjectTypeTemplateCommand"; +import { GetWorkflowCommandInput, GetWorkflowCommandOutput } from "../commands/GetWorkflowCommand"; +import { GetWorkflowStepsCommandInput, GetWorkflowStepsCommandOutput } from "../commands/GetWorkflowStepsCommand"; import { ListAccountIntegrationsCommandInput, ListAccountIntegrationsCommandOutput, @@ -75,6 +82,7 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, } from "../commands/ListTagsForResourceCommand"; +import { ListWorkflowsCommandInput, ListWorkflowsCommandOutput } from "../commands/ListWorkflowsCommand"; import { MergeProfilesCommandInput, MergeProfilesCommandOutput } from "../commands/MergeProfilesCommand"; import { PutIntegrationCommandInput, PutIntegrationCommandOutput } from "../commands/PutIntegrationCommand"; import { PutProfileObjectCommandInput, PutProfileObjectCommandOutput } from "../commands/PutProfileObjectCommand"; @@ -91,8 +99,13 @@ import { CustomerProfilesServiceException as __BaseException } from "../models/C import { AccessDeniedException, Address, + AppflowIntegration, + AppflowIntegrationWorkflowAttributes, + AppflowIntegrationWorkflowMetrics, + AppflowIntegrationWorkflowStep, AutoMerging, BadRequestException, + Batch, ConflictResolution, ConnectorOperator, Consolidation, @@ -103,6 +116,7 @@ import { FlowDefinition, IdentityResolutionJob, IncrementalPullConfig, + IntegrationConfig, InternalServerException, JobSchedule, JobStats, @@ -111,6 +125,7 @@ import { ListProfileObjectsItem, ListProfileObjectTypeItem, ListProfileObjectTypeTemplateItem, + ListWorkflowsItem, MarketoSourceProperties, MatchingRequest, MatchingResponse, @@ -135,6 +150,9 @@ import { TriggerConfig, TriggerProperties, UpdateAddress, + WorkflowAttributes, + WorkflowMetrics, + WorkflowStepItem, ZendeskSourceProperties, } from "../models/models_0"; @@ -216,6 +234,49 @@ export const serializeAws_restJson1CreateDomainCommand = async ( }); }; +export const serializeAws_restJson1CreateIntegrationWorkflowCommand = async ( + input: CreateIntegrationWorkflowCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/domains/{DomainName}/workflows/integrations"; + if (input.DomainName !== undefined) { + const labelValue: string = input.DomainName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: DomainName."); + } + resolvedPath = resolvedPath.replace("{DomainName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: DomainName."); + } + let body: any; + body = JSON.stringify({ + ...(input.IntegrationConfig !== undefined && + input.IntegrationConfig !== null && { + IntegrationConfig: serializeAws_restJson1IntegrationConfig(input.IntegrationConfig, context), + }), + ...(input.ObjectTypeName !== undefined && + input.ObjectTypeName !== null && { ObjectTypeName: input.ObjectTypeName }), + ...(input.RoleArn !== undefined && input.RoleArn !== null && { RoleArn: input.RoleArn }), + ...(input.Tags !== undefined && input.Tags !== null && { Tags: serializeAws_restJson1TagMap(input.Tags, context) }), + ...(input.WorkflowType !== undefined && input.WorkflowType !== null && { WorkflowType: input.WorkflowType }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1CreateProfileCommand = async ( input: CreateProfileCommandInput, context: __SerdeContext @@ -499,6 +560,45 @@ export const serializeAws_restJson1DeleteProfileObjectTypeCommand = async ( }); }; +export const serializeAws_restJson1DeleteWorkflowCommand = async ( + input: DeleteWorkflowCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/domains/{DomainName}/workflows/{WorkflowId}"; + if (input.DomainName !== undefined) { + const labelValue: string = input.DomainName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: DomainName."); + } + resolvedPath = resolvedPath.replace("{DomainName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: DomainName."); + } + if (input.WorkflowId !== undefined) { + const labelValue: string = input.WorkflowId; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: WorkflowId."); + } + resolvedPath = resolvedPath.replace("{WorkflowId}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: WorkflowId."); + } + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "DELETE", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1GetAutoMergingPreviewCommand = async ( input: GetAutoMergingPreviewCommandInput, context: __SerdeContext @@ -743,6 +843,89 @@ export const serializeAws_restJson1GetProfileObjectTypeTemplateCommand = async ( }); }; +export const serializeAws_restJson1GetWorkflowCommand = async ( + input: GetWorkflowCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/domains/{DomainName}/workflows/{WorkflowId}"; + if (input.DomainName !== undefined) { + const labelValue: string = input.DomainName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: DomainName."); + } + resolvedPath = resolvedPath.replace("{DomainName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: DomainName."); + } + if (input.WorkflowId !== undefined) { + const labelValue: string = input.WorkflowId; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: WorkflowId."); + } + resolvedPath = resolvedPath.replace("{WorkflowId}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: WorkflowId."); + } + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + +export const serializeAws_restJson1GetWorkflowStepsCommand = async ( + input: GetWorkflowStepsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/domains/{DomainName}/workflows/{WorkflowId}/steps"; + if (input.DomainName !== undefined) { + const labelValue: string = input.DomainName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: DomainName."); + } + resolvedPath = resolvedPath.replace("{DomainName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: DomainName."); + } + if (input.WorkflowId !== undefined) { + const labelValue: string = input.WorkflowId; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: WorkflowId."); + } + resolvedPath = resolvedPath.replace("{WorkflowId}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: WorkflowId."); + } + const query: any = { + ...(input.NextToken !== undefined && { "next-token": input.NextToken }), + ...(input.MaxResults !== undefined && { "max-results": input.MaxResults.toString() }), + }; + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + query, + body, + }); +}; + export const serializeAws_restJson1ListAccountIntegrationsCommand = async ( input: ListAccountIntegrationsCommandInput, context: __SerdeContext @@ -755,6 +938,7 @@ export const serializeAws_restJson1ListAccountIntegrationsCommand = async ( const query: any = { ...(input.NextToken !== undefined && { "next-token": input.NextToken }), ...(input.MaxResults !== undefined && { "max-results": input.MaxResults.toString() }), + ...(input.IncludeHidden !== undefined && { "include-hidden": input.IncludeHidden.toString() }), }; let body: any; body = JSON.stringify({ @@ -851,6 +1035,7 @@ export const serializeAws_restJson1ListIntegrationsCommand = async ( const query: any = { ...(input.NextToken !== undefined && { "next-token": input.NextToken }), ...(input.MaxResults !== undefined && { "max-results": input.MaxResults.toString() }), + ...(input.IncludeHidden !== undefined && { "include-hidden": input.IncludeHidden.toString() }), }; let body: any; return new __HttpRequest({ @@ -994,6 +1179,50 @@ export const serializeAws_restJson1ListTagsForResourceCommand = async ( }); }; +export const serializeAws_restJson1ListWorkflowsCommand = async ( + input: ListWorkflowsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/domains/{DomainName}/workflows"; + if (input.DomainName !== undefined) { + const labelValue: string = input.DomainName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: DomainName."); + } + resolvedPath = resolvedPath.replace("{DomainName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: DomainName."); + } + const query: any = { + ...(input.NextToken !== undefined && { "next-token": input.NextToken }), + ...(input.MaxResults !== undefined && { "max-results": input.MaxResults.toString() }), + }; + let body: any; + body = JSON.stringify({ + ...(input.QueryEndDate !== undefined && + input.QueryEndDate !== null && { QueryEndDate: Math.round(input.QueryEndDate.getTime() / 1000) }), + ...(input.QueryStartDate !== undefined && + input.QueryStartDate !== null && { QueryStartDate: Math.round(input.QueryStartDate.getTime() / 1000) }), + ...(input.Status !== undefined && input.Status !== null && { Status: input.Status }), + ...(input.WorkflowType !== undefined && input.WorkflowType !== null && { WorkflowType: input.WorkflowType }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + query, + body, + }); +}; + export const serializeAws_restJson1MergeProfilesCommand = async ( input: MergeProfilesCommandInput, context: __SerdeContext @@ -1539,6 +1768,66 @@ const deserializeAws_restJson1CreateDomainCommandError = async ( } }; +export const deserializeAws_restJson1CreateIntegrationWorkflowCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseThis operation allows you to perform reads and singleton writes on data stored in * DynamoDB, using PartiQL.
+ *For PartiQL reads (SELECT statement), if the total number of processed
+ * items exceeds the maximum dataset size limit of 1 MB, the read stops and results are
+ * returned to the user as a LastEvaluatedKey value to continue the read in a
+ * subsequent operation. If the filter criteria in WHERE clause does not match
+ * any data, the read will return an empty result set.
A single SELECT statement response can return up to the maximum number of
+ * items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any
+ * filtering to the results using WHERE clause). If
+ * LastEvaluatedKey is present in the response, you need to paginate the
+ * result set.
This operation allows you to perform reads and singleton writes on data stored in * DynamoDB, using PartiQL.
+ *For PartiQL reads (SELECT statement), if the total number of processed
+ * items exceeds the maximum dataset size limit of 1 MB, the read stops and results are
+ * returned to the user as a LastEvaluatedKey value to continue the read in a
+ * subsequent operation. If the filter criteria in WHERE clause does not match
+ * any data, the read will return an empty result set.
A single SELECT statement response can return up to the maximum number of
+ * items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any
+ * filtering to the results using WHERE clause). If
+ * LastEvaluatedKey is present in the response, you need to paginate the
+ * result set.
The maximum number of items to evaluate (not necessarily the number of matching
+ * items). If DynamoDB processes the number of items up to the limit while processing the
+ * results, it stops the operation and returns the matching values up to that point, along
+ * with a key in LastEvaluatedKey to apply in a subsequent operation so you
+ * can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before
+ * DynamoDB reaches this limit, it stops the operation and returns the matching values up
+ * to the limit, and a key in LastEvaluatedKey to apply in a subsequent
+ * operation to continue the operation.
If a read operation was used, this property will contain the result of the read - * operation; a map of attribute names and their values. For the write operations this - * value will be empty.
- */ - Items?: { [key: string]: AttributeValue }[]; - - /** - *If the response of a read request exceeds the response payload limit DynamoDB will set - * this value in the response. If set, you can use that this value in the subsequent - * request to get the remaining results.
- */ - NextToken?: string; - - /** - *The capacity units consumed by an operation. The data returned includes the total
- * provisioned throughput consumed, along with statistics for the table and any indexes
- * involved in the operation. ConsumedCapacity is only returned if the request
- * asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer
- * Guide.
Represents a set of primary keys and, for each key, the attributes to retrieve from * the table.
@@ -9006,6 +8973,71 @@ export namespace DeleteItemOutput { }); } +export interface ExecuteStatementOutput { + /** + *If a read operation was used, this property will contain the result of the read + * operation; a map of attribute names and their values. For the write operations this + * value will be empty.
+ */ + Items?: { [key: string]: AttributeValue }[]; + + /** + *If the response of a read request exceeds the response payload limit DynamoDB will set + * this value in the response. If set, you can use that this value in the subsequent + * request to get the remaining results.
+ */ + NextToken?: string; + + /** + *The capacity units consumed by an operation. The data returned includes the total
+ * provisioned throughput consumed, along with statistics for the table and any indexes
+ * involved in the operation. ConsumedCapacity is only returned if the request
+ * asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer
+ * Guide.
The primary key of the item where the operation stopped, inclusive of the previous
+ * result set. Use this value to start a new operation, excluding this value in the new
+ * request. If LastEvaluatedKey is empty, then the "last page" of results has
+ * been processed and there is no more data to be retrieved. If
+ * LastEvaluatedKey is not empty, it does not necessarily mean that there
+ * is more data in the result set. The only way to know when you have reached the end of
+ * the result set is when LastEvaluatedKey is empty.
Represents the output of a PutItem operation.
Creates a new component that can be used to build, validate, test, and assess your - * image.
+ * image. The component is based on a YAML document that you specify using exactly one + * of the following methods: + *Inline, using the data property in the request body.
A URL that points to a YAML document file stored in Amazon S3, using the
+ * uri property in the request body.
Creates a new component that can be used to build, validate, test, and assess your - * image.
+ * image. The component is based on a YAML document that you specify using exactly one + * of the following methods: + *Inline, using the data property in the request body.
A URL that points to a YAML document file stored in Amazon S3, using the
+ * uri property in the request body.
Use this property to provide commands or a command script to run when you launch * your build instance.
+ *The userDataOverride property replaces any commands that Image Builder might have added to ensure + * that Systems Manager is installed on your Linux build instance. If you override the user data, + * make sure that you add commands to install Systems Manager, if it is not pre-installed on your + * base image.
*The userDataOverride property replaces any commands that Image Builder might have added to ensure - * that Systems Manager is installed on your Linux build instance. If you override the user data, - * make sure that you add commands to install Systems Manager, if it is not pre-installed on your - * base image.
+ *The user data is always base 64 encoded. For example, the
+ * following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:
+ * #!/bin/bash + *
+ *mkdir -p /var/bb/
+ *touch /var
*The data of the component.
+ *Component data contains the YAML document content for the component.
*/ data?: string; @@ -1276,16 +1284,19 @@ export interface CreateComponentRequest { supportedOsVersions?: string[]; /** - *The data of the component. Used to specify the data inline. Either data or
- * uri can be used to specify the data within the component.
Component data contains inline YAML document content for the component.
+ * Alternatively, you can specify the uri of a YAML document file stored in
+ * Amazon S3. However, you cannot specify both properties.
The uri of the component. Must be an Amazon S3 URL and the requester must have permission to
- * access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service
- * quota. Either data or uri can be used to specify the data within the
- * component.
The uri of a YAML component document file. This must be an S3 URL
+ * (s3://bucket/key), and the requester must have permission to access
+ * the S3 bucket it points to. If you use Amazon S3, you can specify component content
+ * up to your service quota.
Alternatively, you can specify the YAML document inline, using the component
+ * data property. You cannot specify both properties.
Identifies the launch template that the associated Windows AMI uses for + * launching an instance when faster launching is enabled.
+ *You can specify either the launchTemplateName or the
+ * launchTemplateId, but not both.
The ID of the launch template to use for faster launching for a Windows AMI.
+ */ + launchTemplateId?: string; + + /** + *The name of the launch template to use for faster launching for a Windows AMI.
+ */ + launchTemplateName?: string; + + /** + *The version of the launch template to use for faster launching for a Windows AMI.
+ */ + launchTemplateVersion?: string; +} + +export namespace FastLaunchLaunchTemplateSpecification { + /** + * @internal + */ + export const filterSensitiveLog = (obj: FastLaunchLaunchTemplateSpecification): any => ({ + ...obj, + }); +} + +/** + *Configuration settings for creating and managing pre-provisioned snapshots + * for a fast-launch enabled Windows AMI.
+ */ +export interface FastLaunchSnapshotConfiguration { + /** + *The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled + * Windows AMI.
+ */ + targetResourceCount?: number; +} + +export namespace FastLaunchSnapshotConfiguration { + /** + * @internal + */ + export const filterSensitiveLog = (obj: FastLaunchSnapshotConfiguration): any => ({ + ...obj, + }); +} + +/** + *Define and configure faster launching for output Windows AMIs.
+ */ +export interface FastLaunchConfiguration { + /** + *A Boolean that represents the current state of faster launching for the
+ * Windows AMI. Set to true to start using Windows faster launching, or
+ * false to stop using it.
Configuration settings for managing the number of snapshots that are + * created from pre-provisioned instances for the Windows AMI when faster + * launching is enabled.
+ */ + snapshotConfiguration?: FastLaunchSnapshotConfiguration; + + /** + *The maximum number of parallel instances that are launched for creating + * resources.
+ */ + maxParallelLaunches?: number; + + /** + *The launch template that the fast-launch enabled Windows AMI uses when it + * launches Windows instances to create pre-provisioned snapshots.
+ */ + launchTemplate?: FastLaunchLaunchTemplateSpecification; + + /** + *The owner account ID for the fast-launch enabled Windows AMI.
+ */ + accountId?: string; +} + +export namespace FastLaunchConfiguration { + /** + * @internal + */ + export const filterSensitiveLog = (obj: FastLaunchConfiguration): any => ({ + ...obj, + }); +} + /** *Identifies an Amazon EC2 launch template to use for a specific account.
*/ @@ -1672,6 +1783,11 @@ export interface Distribution { * using a file format that is compatible with your VMs in that Region. */ s3ExportConfiguration?: S3ExportConfiguration; + + /** + *The Windows faster-launching configurations to use for AMI distribution.
+ */ + fastLaunchConfigurations?: FastLaunchConfiguration[]; } export namespace Distribution { diff --git a/clients/client-imagebuilder/src/protocols/Aws_restJson1.ts b/clients/client-imagebuilder/src/protocols/Aws_restJson1.ts index 32d5eb76617c..4787e49fbd87 100644 --- a/clients/client-imagebuilder/src/protocols/Aws_restJson1.ts +++ b/clients/client-imagebuilder/src/protocols/Aws_restJson1.ts @@ -165,6 +165,9 @@ import { DistributionConfiguration, DistributionConfigurationSummary, EbsInstanceBlockDeviceSpecification, + FastLaunchConfiguration, + FastLaunchLaunchTemplateSpecification, + FastLaunchSnapshotConfiguration, Filter, ForbiddenException, IdempotentParameterMismatchException, @@ -5570,6 +5573,13 @@ const serializeAws_restJson1Distribution = (input: Distribution, context: __Serd context ), }), + ...(input.fastLaunchConfigurations !== undefined && + input.fastLaunchConfigurations !== null && { + fastLaunchConfigurations: serializeAws_restJson1FastLaunchConfigurationList( + input.fastLaunchConfigurations, + context + ), + }), ...(input.launchTemplateConfigurations !== undefined && input.launchTemplateConfigurations !== null && { launchTemplateConfigurations: serializeAws_restJson1LaunchTemplateConfigurationList( @@ -5620,6 +5630,67 @@ const serializeAws_restJson1EbsInstanceBlockDeviceSpecification = ( }; }; +const serializeAws_restJson1FastLaunchConfiguration = ( + input: FastLaunchConfiguration, + context: __SerdeContext +): any => { + return { + ...(input.accountId !== undefined && input.accountId !== null && { accountId: input.accountId }), + ...(input.enabled !== undefined && input.enabled !== null && { enabled: input.enabled }), + ...(input.launchTemplate !== undefined && + input.launchTemplate !== null && { + launchTemplate: serializeAws_restJson1FastLaunchLaunchTemplateSpecification(input.launchTemplate, context), + }), + ...(input.maxParallelLaunches !== undefined && + input.maxParallelLaunches !== null && { maxParallelLaunches: input.maxParallelLaunches }), + ...(input.snapshotConfiguration !== undefined && + input.snapshotConfiguration !== null && { + snapshotConfiguration: serializeAws_restJson1FastLaunchSnapshotConfiguration( + input.snapshotConfiguration, + context + ), + }), + }; +}; + +const serializeAws_restJson1FastLaunchConfigurationList = ( + input: FastLaunchConfiguration[], + context: __SerdeContext +): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + if (entry === null) { + return null as any; + } + return serializeAws_restJson1FastLaunchConfiguration(entry, context); + }); +}; + +const serializeAws_restJson1FastLaunchLaunchTemplateSpecification = ( + input: FastLaunchLaunchTemplateSpecification, + context: __SerdeContext +): any => { + return { + ...(input.launchTemplateId !== undefined && + input.launchTemplateId !== null && { launchTemplateId: input.launchTemplateId }), + ...(input.launchTemplateName !== undefined && + input.launchTemplateName !== null && { launchTemplateName: input.launchTemplateName }), + ...(input.launchTemplateVersion !== undefined && + input.launchTemplateVersion !== null && { launchTemplateVersion: input.launchTemplateVersion }), + }; +}; + +const serializeAws_restJson1FastLaunchSnapshotConfiguration = ( + input: FastLaunchSnapshotConfiguration, + context: __SerdeContext +): any => { + return { + ...(input.targetResourceCount !== undefined && + input.targetResourceCount !== null && { targetResourceCount: input.targetResourceCount }), + }; +}; + const serializeAws_restJson1Filter = (input: Filter, context: __SerdeContext): any => { return { ...(input.name !== undefined && input.name !== null && { name: input.name }), @@ -6302,6 +6373,10 @@ const deserializeAws_restJson1Distribution = (output: any, context: __SerdeConte output.containerDistributionConfiguration !== undefined && output.containerDistributionConfiguration !== null ? deserializeAws_restJson1ContainerDistributionConfiguration(output.containerDistributionConfiguration, context) : undefined, + fastLaunchConfigurations: + output.fastLaunchConfigurations !== undefined && output.fastLaunchConfigurations !== null + ? deserializeAws_restJson1FastLaunchConfigurationList(output.fastLaunchConfigurations, context) + : undefined, launchTemplateConfigurations: output.launchTemplateConfigurations !== undefined && output.launchTemplateConfigurations !== null ? deserializeAws_restJson1LaunchTemplateConfigurationList(output.launchTemplateConfigurations, context) @@ -6404,6 +6479,60 @@ const deserializeAws_restJson1EbsInstanceBlockDeviceSpecification = ( } as any; }; +const deserializeAws_restJson1FastLaunchConfiguration = ( + output: any, + context: __SerdeContext +): FastLaunchConfiguration => { + return { + accountId: __expectString(output.accountId), + enabled: __expectBoolean(output.enabled), + launchTemplate: + output.launchTemplate !== undefined && output.launchTemplate !== null + ? deserializeAws_restJson1FastLaunchLaunchTemplateSpecification(output.launchTemplate, context) + : undefined, + maxParallelLaunches: __expectInt32(output.maxParallelLaunches), + snapshotConfiguration: + output.snapshotConfiguration !== undefined && output.snapshotConfiguration !== null + ? deserializeAws_restJson1FastLaunchSnapshotConfiguration(output.snapshotConfiguration, context) + : undefined, + } as any; +}; + +const deserializeAws_restJson1FastLaunchConfigurationList = ( + output: any, + context: __SerdeContext +): FastLaunchConfiguration[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1FastLaunchConfiguration(entry, context); + }); + return retVal; +}; + +const deserializeAws_restJson1FastLaunchLaunchTemplateSpecification = ( + output: any, + context: __SerdeContext +): FastLaunchLaunchTemplateSpecification => { + return { + launchTemplateId: __expectString(output.launchTemplateId), + launchTemplateName: __expectString(output.launchTemplateName), + launchTemplateVersion: __expectString(output.launchTemplateVersion), + } as any; +}; + +const deserializeAws_restJson1FastLaunchSnapshotConfiguration = ( + output: any, + context: __SerdeContext +): FastLaunchSnapshotConfiguration => { + return { + targetResourceCount: __expectInt32(output.targetResourceCount), + } as any; +}; + const deserializeAws_restJson1Image = (output: any, context: __SerdeContext): Image => { return { arn: __expectString(output.arn), diff --git a/clients/client-iotsecuretunneling/src/endpoints.ts b/clients/client-iotsecuretunneling/src/endpoints.ts index 3303ebfb00ac..88df6e859669 100644 --- a/clients/client-iotsecuretunneling/src/endpoints.ts +++ b/clients/client-iotsecuretunneling/src/endpoints.ts @@ -1,7 +1,64 @@ import { getRegionInfo, PartitionHash, RegionHash } from "@aws-sdk/config-resolver"; import { RegionInfoProvider, RegionInfoProviderOptions } from "@aws-sdk/types"; -const regionHash: RegionHash = {}; +const regionHash: RegionHash = { + "ca-central-1": { + variants: [ + { + hostname: "api.tunneling.iot-fips.ca-central-1.amazonaws.com", + tags: ["fips"], + }, + ], + }, + "us-east-1": { + variants: [ + { + hostname: "api.tunneling.iot-fips.us-east-1.amazonaws.com", + tags: ["fips"], + }, + ], + }, + "us-east-2": { + variants: [ + { + hostname: "api.tunneling.iot-fips.us-east-2.amazonaws.com", + tags: ["fips"], + }, + ], + }, + "us-gov-east-1": { + variants: [ + { + hostname: "api.tunneling.iot-fips.us-gov-east-1.amazonaws.com", + tags: ["fips"], + }, + ], + }, + "us-gov-west-1": { + variants: [ + { + hostname: "api.tunneling.iot-fips.us-gov-west-1.amazonaws.com", + tags: ["fips"], + }, + ], + }, + "us-west-1": { + variants: [ + { + hostname: "api.tunneling.iot-fips.us-west-1.amazonaws.com", + tags: ["fips"], + }, + ], + }, + "us-west-2": { + variants: [ + { + hostname: "api.tunneling.iot-fips.us-west-2.amazonaws.com", + tags: ["fips"], + }, + ], + }, +}; const partitionHash: PartitionHash = { aws: { @@ -22,6 +79,11 @@ const partitionHash: PartitionHash = { "eu-west-1", "eu-west-2", "eu-west-3", + "fips-ca-central-1", + "fips-us-east-1", + "fips-us-east-2", + "fips-us-west-1", + "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", @@ -100,7 +162,7 @@ const partitionHash: PartitionHash = { ], }, "aws-us-gov": { - regions: ["us-gov-east-1", "us-gov-west-1"], + regions: ["fips-us-gov-east-1", "fips-us-gov-west-1", "us-gov-east-1", "us-gov-west-1"], regionRegex: "^us\\-gov\\-\\w+\\-\\d+$", variants: [ { diff --git a/clients/client-lambda/src/Lambda.ts b/clients/client-lambda/src/Lambda.ts index 337ccc8dbbfe..99f56099447c 100644 --- a/clients/client-lambda/src/Lambda.ts +++ b/clients/client-lambda/src/Lambda.ts @@ -2394,11 +2394,24 @@ export class Lambda extends LambdaClient { *Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed * by a trusted publisher. For more information, see Configuring code signing.
* + *If the function's package type is Image, you must specify the code package in ImageUri as
+ * the URI of a
+ * container image
+ * in the Amazon ECR registry.
+ *
If the function's package type is Zip, you must specify the deployment
+ * package as a .zip file
+ * archive. Enter the Amazon S3 bucket and key of the code .zip file location.
+ * You can also provide the function code inline using the ZipFile field.
The code in the deployment package must be compatible with the target instruction set
+ * architecture of the function (x86-64 or arm64).
The function's code is locked when you publish a version. You can't modify the code of a published version, * only the unpublished version.
*For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if - * you update the image tag to a new image, Lambda does not automatically update the function.
+ * you update the image tag to a new image, Lambda does not automatically update the function. *Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed * by a trusted publisher. For more information, see Configuring code signing.
* + *If the function's package type is Image, you must specify the code package in ImageUri as
+ * the URI of a
+ * container image
+ * in the Amazon ECR registry.
+ *
If the function's package type is Zip, you must specify the deployment
+ * package as a .zip file
+ * archive. Enter the Amazon S3 bucket and key of the code .zip file location.
+ * You can also provide the function code inline using the ZipFile field.
The code in the deployment package must be compatible with the target instruction set
+ * architecture of the function (x86-64 or arm64).
The function's code is locked when you publish a version. You can't modify the code of a published version, * only the unpublished version.
*For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if - * you update the image tag to a new image, Lambda does not automatically update the function.
+ * you update the image tag to a new image, Lambda does not automatically update the function. *The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for - * you.
+ *The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients + * handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.
*/ ZipFile?: Uint8Array; /** - *An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.
+ *An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different + * Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
*/ S3Bucket?: string; /** - *The Amazon S3 key of the deployment package.
+ *The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
*/ S3Key?: string; @@ -5659,7 +5661,8 @@ export interface UpdateFunctionCodeRequest { S3ObjectVersion?: string; /** - *URI of a container image in the Amazon ECR registry.
+ *URI of a container image in the Amazon ECR registry. Do not use for a function defined + * with a .zip file archive.
*/ ImageUri?: string; diff --git a/clients/client-lambda/src/waiters/index.ts b/clients/client-lambda/src/waiters/index.ts index 108d52ffeab6..dcfbc1a1ef8a 100644 --- a/clients/client-lambda/src/waiters/index.ts +++ b/clients/client-lambda/src/waiters/index.ts @@ -1,3 +1,5 @@ export * from "./waitForFunctionActive"; +export * from "./waitForFunctionActiveV2"; export * from "./waitForFunctionExists"; export * from "./waitForFunctionUpdated"; +export * from "./waitForFunctionUpdatedV2"; diff --git a/clients/client-lambda/src/waiters/waitForFunctionActive.ts b/clients/client-lambda/src/waiters/waitForFunctionActive.ts index e911dbb1ac37..a6fab6ba63e7 100644 --- a/clients/client-lambda/src/waiters/waitForFunctionActive.ts +++ b/clients/client-lambda/src/waiters/waitForFunctionActive.ts @@ -41,7 +41,7 @@ const checkState = async (client: LambdaClient, input: GetFunctionConfigurationC return { state: WaiterState.RETRY, reason }; }; /** - * Waits for the function's State to be Active. + * Waits for the function's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation. * @deprecated Use waitUntilFunctionActive instead. waitForFunctionActive does not throw error in non-success cases. */ export const waitForFunctionActive = async ( @@ -52,7 +52,7 @@ export const waitForFunctionActive = async ( return createWaiter({ ...serviceDefaults, ...params }, input, checkState); }; /** - * Waits for the function's State to be Active. + * Waits for the function's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation. * @param params - Waiter configuration options. * @param input - The input to GetFunctionConfigurationCommand for polling. */ diff --git a/clients/client-lambda/src/waiters/waitForFunctionActiveV2.ts b/clients/client-lambda/src/waiters/waitForFunctionActiveV2.ts new file mode 100644 index 000000000000..8b42a9242b8e --- /dev/null +++ b/clients/client-lambda/src/waiters/waitForFunctionActiveV2.ts @@ -0,0 +1,63 @@ +import { checkExceptions, createWaiter, WaiterConfiguration, WaiterResult, WaiterState } from "@aws-sdk/util-waiter"; + +import { GetFunctionCommand, GetFunctionCommandInput } from "../commands/GetFunctionCommand"; +import { LambdaClient } from "../LambdaClient"; + +const checkState = async (client: LambdaClient, input: GetFunctionCommandInput): PromiseSpecifies the location for the file being copied. Only applicable for the Copy type of workflow steps.
+ *Specifies the location for the file being copied. Only applicable for Copy type workflow
+ * steps. Use ${Transfer:username} in this field to parametrize the destination
+ * prefix by username.
FALSE.
*/
OverwriteExisting?: OverwriteExisting | string;
+
+ /**
+ * Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file + * for the workflow.
+ *Enter ${previous.file} to use the previous file as the input.
+ * In this case, this workflow step uses the output file from the previous workflow step as input.
+ * This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
* [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
*
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
- * holders for your directory. If using the CLI, use the s3api or efsapi call instead of
- * s3 or efs so you can use the put-object operation. For example, you use the
- * following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make
- * sure that the end of the key name ends in a / for it to be considered a folder.
* [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
*
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
- * holders for your directory. If using the CLI, use the s3api or efsapi call instead of
- * s3 or efs so you can use the put-object operation. For example, you use the
- * following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make
- * sure that the end of the key name ends in a / for it to be considered a folder.
* [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
*
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
- * holders for your directory. If using the CLI, use the s3api or efsapi call instead of
- * s3 or efs so you can use the put-object operation. For example, you use the
- * following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make
- * sure that the end of the key name ends in a / for it to be considered a folder.
Timeout, in seconds, for the step.
*/ TimeoutSeconds?: number; + + /** + *Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file + * for the workflow.
+ *Enter ${previous.file} to use the previous file as the input.
+ * In this case, this workflow step uses the output file from the previous workflow step as input.
+ * This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
The name of the step, used as an identifier.
*/ Name?: string; + + /** + *Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file + * for the workflow.
+ *Enter ${previous.file} to use the previous file as the input.
+ * In this case, this workflow step uses the output file from the previous workflow step as input.
+ * This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
Array that contains from 1 to 10 key/value pairs.
*/ Tags?: S3Tag[]; + + /** + *Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file + * for the workflow.
+ *Enter ${previous.file} to use the previous file as the input.
+ * In this case, this workflow step uses the output file from the previous workflow step as input.
+ * This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
A message that indicates whether the test was successful or not.
+ *If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.
+ *
* [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
*
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
- * holders for your directory. If using the CLI, use the s3api or efsapi call instead of
- * s3 or efs so you can use the put-object operation. For example, you use the
- * following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make
- * sure that the end of the key name ends in a / for it to be considered a folder.
* [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
*
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
- * holders for your directory. If using the CLI, use the s3api or efsapi call instead of
- * s3 or efs so you can use the put-object operation. For example, you use the
- * following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make
- * sure that the end of the key name ends in a / for it to be considered a folder.
Settings that configure the translation output.
*/ export interface TranslationSettings { + Formality?: Formality | string; /** *Enable the profanity setting if you want Amazon Translate to mask profane words and * phrases in your translation output.
diff --git a/clients/client-translate/src/protocols/Aws_json1_1.ts b/clients/client-translate/src/protocols/Aws_json1_1.ts index a33c9edfd774..8e9ef33108a0 100644 --- a/clients/client-translate/src/protocols/Aws_json1_1.ts +++ b/clients/client-translate/src/protocols/Aws_json1_1.ts @@ -1452,6 +1452,7 @@ const serializeAws_json1_1TranslateTextRequest = (input: TranslateTextRequest, c const serializeAws_json1_1TranslationSettings = (input: TranslationSettings, context: __SerdeContext): any => { return { + ...(input.Formality !== undefined && input.Formality !== null && { Formality: input.Formality }), ...(input.Profanity !== undefined && input.Profanity !== null && { Profanity: input.Profanity }), }; }; @@ -2040,6 +2041,7 @@ const deserializeAws_json1_1TranslateTextResponse = (output: any, context: __Ser const deserializeAws_json1_1TranslationSettings = (output: any, context: __SerdeContext): TranslationSettings => { return { + Formality: __expectString(output.Formality), Profanity: __expectString(output.Profanity), } as any; }; diff --git a/clients/client-wafv2/src/WAFV2.ts b/clients/client-wafv2/src/WAFV2.ts index 0a154d67f2ad..910fadba5c6d 100644 --- a/clients/client-wafv2/src/WAFV2.ts +++ b/clients/client-wafv2/src/WAFV2.ts @@ -766,7 +766,8 @@ export class WAFV2 extends WAFV2Client { /** *Generates a presigned download URL for the specified release of the mobile SDK.
- *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
+ *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see + * WAF client application integration in the WAF Developer Guide.
*/ public generateMobileSdkReleaseUrl( args: GenerateMobileSdkReleaseUrlCommandInput, @@ -893,7 +894,8 @@ export class WAFV2 extends WAFV2Client { /** *Retrieves information for the specified mobile SDK release, including release notes and tags.
- *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
+ *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see + * WAF client application integration in the WAF Developer Guide.
*/ public getMobileSdkRelease( args: GetMobileSdkReleaseCommandInput, @@ -1316,7 +1318,8 @@ export class WAFV2 extends WAFV2Client { /** *Retrieves a list of the available releases for the mobile SDK and the specified device platform.
- *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
+ *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see + * WAF client application integration in the WAF Developer Guide.
*/ public listMobileSdkReleases( args: ListMobileSdkReleasesCommandInput, @@ -1515,8 +1518,11 @@ export class WAFV2 extends WAFV2Client { /** *Enables the specified LoggingConfiguration, to start logging from a - * web ACL, according to the configuration provided.
- *You can access information about all traffic that WAF inspects using the following + * web ACL, according to the configuration provided.
+ *You can define one logging destination per web ACL.
+ *You can access information about the traffic that WAF inspects using the following * steps:
*For additional information about web ACL logging, see + * Logging web ACL traffic information + * in the WAF Developer Guide.
*This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.
*Generates a presigned download URL for the specified release of the mobile SDK.
- *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
+ *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see + * WAF client application integration in the WAF Developer Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-wafv2/src/commands/GetMobileSdkReleaseCommand.ts b/clients/client-wafv2/src/commands/GetMobileSdkReleaseCommand.ts index a38480ad98de..53e9ad2504b8 100644 --- a/clients/client-wafv2/src/commands/GetMobileSdkReleaseCommand.ts +++ b/clients/client-wafv2/src/commands/GetMobileSdkReleaseCommand.ts @@ -23,7 +23,8 @@ export interface GetMobileSdkReleaseCommandOutput extends GetMobileSdkReleaseRes /** *Retrieves information for the specified mobile SDK release, including release notes and tags.
- *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
+ *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see + * WAF client application integration in the WAF Developer Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-wafv2/src/commands/ListMobileSdkReleasesCommand.ts b/clients/client-wafv2/src/commands/ListMobileSdkReleasesCommand.ts index c125cf5b2e3e..5cc945fcc047 100644 --- a/clients/client-wafv2/src/commands/ListMobileSdkReleasesCommand.ts +++ b/clients/client-wafv2/src/commands/ListMobileSdkReleasesCommand.ts @@ -23,7 +23,8 @@ export interface ListMobileSdkReleasesCommandOutput extends ListMobileSdkRelease /** *Retrieves a list of the available releases for the mobile SDK and the specified device platform.
- *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
+ *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see + * WAF client application integration in the WAF Developer Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-wafv2/src/commands/PutLoggingConfigurationCommand.ts b/clients/client-wafv2/src/commands/PutLoggingConfigurationCommand.ts index d0a5bf6075a3..07b1d5c77c07 100644 --- a/clients/client-wafv2/src/commands/PutLoggingConfigurationCommand.ts +++ b/clients/client-wafv2/src/commands/PutLoggingConfigurationCommand.ts @@ -23,8 +23,11 @@ export interface PutLoggingConfigurationCommandOutput extends PutLoggingConfigur /** *Enables the specified LoggingConfiguration, to start logging from a - * web ACL, according to the configuration provided.
- *You can access information about all traffic that WAF inspects using the following + * web ACL, according to the configuration provided.
+ *You can define one logging destination per web ACL.
+ *You can access information about the traffic that WAF inspects using the following * steps:
*For additional information about web ACL logging, see + * Logging web ACL traffic information + * in the WAF Developer Guide.
*This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.
*The login endpoint for your application. For example https://example.com/web/login.
The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login.
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
- *Examples:
+ *Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
+ *Example address strings:
*To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
+ *Example JSON Addresses specifications:
Empty array: "Addresses": []
+ *
Array with one address: "Addresses": ["192.0.2.44/32"]
+ *
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
+ *
INVALID specification: "Addresses": [""] INVALID
Contains one or more IP addresses or blocks of IP addresses specified in Classless + *
Contains zero or more IP addresses or blocks of IP addresses specified in Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0. For information about CIDR notation, see the Wikipedia entry Classless * Inter-Domain Routing.
@@ -3468,8 +3486,8 @@ export interface IPSet { IPAddressVersion: IPAddressVersion | string | undefined; /** - *Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
- *Examples:
+ *Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
+ *Example address strings:
*To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
+ *Example JSON Addresses specifications:
Empty array: "Addresses": []
+ *
Array with one address: "Addresses": ["192.0.2.44/32"]
+ *
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
+ *
INVALID specification: "Addresses": [""] INVALID
For information about configuring web ACL logging destinations, see
+ * You can define one logging destination per web ACL.
You can access information about the traffic that WAF inspects using the following + * steps:
+ *Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. + * For information about configuring logging destinations and the permissions that are required for each, see + * Logging web ACL traffic information + * in the WAF Developer Guide.
+ *Associate your logging destination to your web ACL using a
+ * PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration
+ * request, WAF creates an additional role or policy that is required to write
+ * logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.
+ * For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see * Logging web ACL traffic information * in the WAF Developer Guide.
*/ @@ -3667,8 +3724,11 @@ export interface LoggingConfiguration { ResourceArn: string | undefined; /** - *The Amazon Resource Names (ARNs) of the logging destinations that you want to associate + *
The logging destination configuration that you want to associate * with the web ACL.
+ *You can associate one logging destination to a web ACL.
+ *Information for a release of the mobile SDK, including release notes and tags.
- *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
+ *The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see + * WAF client application integration in the WAF Developer Guide.
*/ export interface MobileSdkRelease { /** @@ -5834,8 +5895,8 @@ export interface UpdateIPSetRequest { Description?: string; /** - *Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
- *Examples:
+ *Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
+ *Example address strings:
*To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
+ *Example JSON Addresses specifications:
Empty array: "Addresses": []
+ *
Array with one address: "Addresses": ["192.0.2.44/32"]
+ *
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
+ *
INVALID specification: "Addresses": [""] INVALID
The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF application integration in the WAF Developer Guide.
The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.
A generic address associated with the customer that is not mailing, shipping, or\n billing.
" } }, + "com.amazonaws.customerprofiles#AppflowIntegration": { + "type": "structure", + "members": { + "FlowDefinition": { + "target": "com.amazonaws.customerprofiles#FlowDefinition", + "traits": { + "smithy.api#required": {} + } + }, + "Batches": { + "target": "com.amazonaws.customerprofiles#Batches", + "traits": { + "smithy.api#documentation": "Batches in workflow of type APPFLOW_INTEGRATION.
Details for workflow of type APPFLOW_INTEGRATION.
Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.
", + "smithy.api#required": {} + } + }, + "ConnectorProfileName": { + "target": "com.amazonaws.customerprofiles#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "The name of the AppFlow connector profile used for ingestion.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Structure holding all APPFLOW_INTEGRATION specific workflow attributes.
Number of records processed in APPFLOW_INTEGRATION workflow.
Total steps completed in APPFLOW_INTEGRATION workflow.
Total steps in APPFLOW_INTEGRATION workflow.
Workflow specific execution metrics for APPFLOW_INTEGRATION workflow.
Name of the flow created during execution of workflow step. APPFLOW_INTEGRATION workflow type creates an appflow flow during workflow step execution on the customers behalf.
Workflow step status for APPFLOW_INTEGRATION workflow.
Message indicating execution of workflow step for APPFLOW_INTEGRATION workflow.
Total number of records processed during execution of workflow step for APPFLOW_INTEGRATION workflow.
Start datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.
End datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.
Creation timestamp of workflow step for APPFLOW_INTEGRATION workflow.
Last updated timestamp for workflow step for APPFLOW_INTEGRATION workflow.
Workflow step details for APPFLOW_INTEGRATION workflow.
Start time of batch to split ingestion.
", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "End time of batch to split ingestion.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Batch defines the boundaries for ingestion for each step in APPFLOW_INTEGRATION workflow. APPFLOW_INTEGRATION workflow splits ingestion based on these boundaries.
\n\tCreates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.\n\t
", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/workflows/integrations", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#CreateIntegrationWorkflowRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkflowType": { + "target": "com.amazonaws.customerprofiles#WorkflowType", + "traits": { + "smithy.api#documentation": "The type of workflow. The only supported value is APPFLOW_INTEGRATION.
", + "smithy.api#required": {} + } + }, + "IntegrationConfig": { + "target": "com.amazonaws.customerprofiles#IntegrationConfig", + "traits": { + "smithy.api#documentation": "Configuration data for integration workflow.
", + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "The name of the profile object type.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.customerprofiles#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + } + }, + "com.amazonaws.customerprofiles#CreateIntegrationWorkflowResponse": { + "type": "structure", + "members": { + "WorkflowId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "Unique identifier for the workflow.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "A message indicating create request was received.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.customerprofiles#CreateProfile": { "type": "operation", "input": { @@ -717,6 +986,9 @@ { "target": "com.amazonaws.customerprofiles#CreateDomain" }, + { + "target": "com.amazonaws.customerprofiles#CreateIntegrationWorkflow" + }, { "target": "com.amazonaws.customerprofiles#CreateProfile" }, @@ -738,6 +1010,9 @@ { "target": "com.amazonaws.customerprofiles#DeleteProfileObjectType" }, + { + "target": "com.amazonaws.customerprofiles#DeleteWorkflow" + }, { "target": "com.amazonaws.customerprofiles#GetAutoMergingPreview" }, @@ -759,6 +1034,12 @@ { "target": "com.amazonaws.customerprofiles#GetProfileObjectTypeTemplate" }, + { + "target": "com.amazonaws.customerprofiles#GetWorkflow" + }, + { + "target": "com.amazonaws.customerprofiles#GetWorkflowSteps" + }, { "target": "com.amazonaws.customerprofiles#ListAccountIntegrations" }, @@ -783,6 +1064,9 @@ { "target": "com.amazonaws.customerprofiles#ListTagsForResource" }, + { + "target": "com.amazonaws.customerprofiles#ListWorkflows" + }, { "target": "com.amazonaws.customerprofiles#MergeProfiles" }, @@ -1255,6 +1539,65 @@ } } }, + "com.amazonaws.customerprofiles#DeleteWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#DeleteWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#DeleteWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified workflow and all its corresponding resources. This is an async process.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/domains/{DomainName}/workflows/{WorkflowId}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#DeleteWorkflowRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkflowId": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "Unique identifier for the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteWorkflowResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.customerprofiles#DestinationField": { "type": "string", "traits": { @@ -2029,6 +2372,12 @@ "traits": { "smithy.api#documentation": "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.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
Unique identifier for the workflow.
" + } } } }, @@ -2058,7 +2407,7 @@ } ], "traits": { - "smithy.api#documentation": "Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.
\nThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
Amazon Connect uses the following profile attributes to identify matches:
\nPhoneNumber
\nHomePhoneNumber
\nBusinessPhoneNumber
\nMobilePhoneNumber
\nEmailAddress
\nPersonalEmailAddress
\nBusinessEmailAddress
\nFullName
\nBusinessName
\nFor example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
", + "smithy.api#documentation": "Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.
\nThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
Amazon Connect uses the following profile attributes to identify matches:
\nPhoneNumber
\nHomePhoneNumber
\nBusinessPhoneNumber
\nMobilePhoneNumber
\nEmailAddress
\nPersonalEmailAddress
\nBusinessEmailAddress
\nFullName
\nFor example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
", "smithy.api#http": { "method": "GET", "uri": "/domains/{DomainName}/matches", @@ -2303,49 +2652,255 @@ } } }, - "com.amazonaws.customerprofiles#GetProfileObjectTypeTemplateResponse": { + "com.amazonaws.customerprofiles#GetProfileObjectTypeTemplateResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "A unique identifier for the object template.
" + } + }, + "SourceName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The name of the source of the object template.
" + } + }, + "SourceObject": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The source of the object template.
" + } + }, + "AllowProfileCreation": { + "target": "com.amazonaws.customerprofiles#boolean", + "traits": { + "smithy.api#documentation": "Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.
The format of your sourceLastUpdatedTimestamp that was previously set\n up.
A map of the name and ObjectType field.
" + } + }, + "Keys": { + "target": "com.amazonaws.customerprofiles#KeyMap", + "traits": { + "smithy.api#documentation": "A list of unique keys that can be used to map data to the profile.
" + } + } + } + }, + "com.amazonaws.customerprofiles#GetWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#GetWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#GetWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get details of specified workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}/workflows/{WorkflowId}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#GetWorkflowRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkflowId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "Unique identifier for the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#GetWorkflowResponse": { + "type": "structure", + "members": { + "WorkflowId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "Unique identifier for the workflow.
" + } + }, + "WorkflowType": { + "target": "com.amazonaws.customerprofiles#WorkflowType", + "traits": { + "smithy.api#documentation": "The type of workflow. The only supported value is APPFLOW_INTEGRATION.
" + } + }, + "Status": { + "target": "com.amazonaws.customerprofiles#Status", + "traits": { + "smithy.api#documentation": "Status of workflow execution.
" + } + }, + "ErrorDescription": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "Workflow error messages during execution (if any).
" + } + }, + "StartDate": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp that represents when workflow execution started.
" + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp that represents when workflow execution last updated.
" + } + }, + "Attributes": { + "target": "com.amazonaws.customerprofiles#WorkflowAttributes", + "traits": { + "smithy.api#documentation": "Attributes provided for workflow execution.
" + } + }, + "Metrics": { + "target": "com.amazonaws.customerprofiles#WorkflowMetrics", + "traits": { + "smithy.api#documentation": "Workflow specific execution metrics.
" + } + } + } + }, + "com.amazonaws.customerprofiles#GetWorkflowSteps": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#GetWorkflowStepsRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#GetWorkflowStepsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get granular list of steps in workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}/workflows/{WorkflowId}/steps", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#GetWorkflowStepsRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkflowId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "Unique identifier for the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.customerprofiles#GetWorkflowStepsResponse": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.customerprofiles#name", - "traits": { - "smithy.api#documentation": "A unique identifier for the object template.
" - } - }, - "SourceName": { - "target": "com.amazonaws.customerprofiles#name", - "traits": { - "smithy.api#documentation": "The name of the source of the object template.
" - } - }, - "SourceObject": { - "target": "com.amazonaws.customerprofiles#name", - "traits": { - "smithy.api#documentation": "The source of the object template.
" - } - }, - "AllowProfileCreation": { - "target": "com.amazonaws.customerprofiles#boolean", + "WorkflowId": { + "target": "com.amazonaws.customerprofiles#uuid", "traits": { - "smithy.api#documentation": "Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.
Unique identifier for the workflow.
" } }, - "SourceLastUpdatedTimestampFormat": { - "target": "com.amazonaws.customerprofiles#string1To255", + "WorkflowType": { + "target": "com.amazonaws.customerprofiles#WorkflowType", "traits": { - "smithy.api#documentation": "The format of your sourceLastUpdatedTimestamp that was previously set\n up.
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
" } }, - "Fields": { - "target": "com.amazonaws.customerprofiles#FieldMap", + "Items": { + "target": "com.amazonaws.customerprofiles#WorkflowStepsList", "traits": { - "smithy.api#documentation": "A map of the name and ObjectType field.
" + "smithy.api#documentation": "List containing workflow step details.
" } }, - "Keys": { - "target": "com.amazonaws.customerprofiles#KeyMap", + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", "traits": { - "smithy.api#documentation": "A list of unique keys that can be used to map data to the profile.
" + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" } } } @@ -2461,6 +3016,20 @@ "smithy.api#documentation": "Specifies the configuration used when importing incremental records from the\n source.
" } }, + "com.amazonaws.customerprofiles#IntegrationConfig": { + "type": "structure", + "members": { + "AppflowIntegration": { + "target": "com.amazonaws.customerprofiles#AppflowIntegration", + "traits": { + "smithy.api#documentation": "Configuration data for APPFLOW_INTEGRATION workflow type.
Configuration data for integration workflow.
" + } + }, "com.amazonaws.customerprofiles#IntegrationList": { "type": "list", "member": { @@ -2649,6 +3218,13 @@ "smithy.api#documentation": "The maximum number of objects returned per page.
", "smithy.api#httpQuery": "max-results" } + }, + "IncludeHidden": { + "target": "com.amazonaws.customerprofiles#optionalBoolean", + "traits": { + "smithy.api#documentation": "Boolean to indicate if hidden integration should be returned. Defaults to False.
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.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
Unique identifier for the workflow.
" + } } }, "traits": { @@ -2964,6 +3546,13 @@ "smithy.api#documentation": "The maximum number of objects returned per page.
", "smithy.api#httpQuery": "max-results" } + }, + "IncludeHidden": { + "target": "com.amazonaws.customerprofiles#optionalBoolean", + "traits": { + "smithy.api#documentation": "Boolean to indicate if hidden integration should be returned. Defaults to False.
Query to list all workflows.
", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/workflows", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#ListWorkflowsItem": { + "type": "structure", + "members": { + "WorkflowType": { + "target": "com.amazonaws.customerprofiles#WorkflowType", + "traits": { + "smithy.api#documentation": "The type of workflow. The only supported value is APPFLOW_INTEGRATION.
", + "smithy.api#required": {} + } + }, + "WorkflowId": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "Unique identifier for the workflow.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.customerprofiles#Status", + "traits": { + "smithy.api#documentation": "Status of workflow execution.
", + "smithy.api#required": {} + } + }, + "StatusDescription": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "Description for workflow execution status.
", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "Creation timestamp for workflow.
", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "Last updated timestamp for workflow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A workflow in list of workflows.
" + } + }, + "com.amazonaws.customerprofiles#ListWorkflowsRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkflowType": { + "target": "com.amazonaws.customerprofiles#WorkflowType", + "traits": { + "smithy.api#documentation": "The type of workflow. The only supported value is APPFLOW_INTEGRATION.
" + } + }, + "Status": { + "target": "com.amazonaws.customerprofiles#Status", + "traits": { + "smithy.api#documentation": "Status of workflow execution.
" + } + }, + "QueryStartDate": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "Retrieve workflows started after timestamp.
" + } + }, + "QueryEndDate": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "Retrieve workflows ended after timestamp.
" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.customerprofiles#ListWorkflowsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.customerprofiles#WorkflowList", + "traits": { + "smithy.api#documentation": "List containing workflow details.
" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + } + } + }, "com.amazonaws.customerprofiles#MarketoConnectorOperator": { "type": "string", "traits": { @@ -4148,6 +4889,12 @@ "traits": { "smithy.api#documentation": "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.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
Unique identifier for the workflow.
" + } } } }, @@ -4425,6 +5172,16 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.customerprofiles#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^arn:aws:iam:.*:[0-9]+:" + } + }, "com.amazonaws.customerprofiles#S3ConnectorOperator": { "type": "string", "traits": { @@ -5111,6 +5868,41 @@ "target": "com.amazonaws.customerprofiles#StandardIdentifier" } }, + "com.amazonaws.customerprofiles#Status": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_STARTED", + "name": "NOT_STARTED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SPLIT", + "name": "SPLIT" + }, + { + "value": "RETRY", + "name": "RETRY" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, "com.amazonaws.customerprofiles#TagArn": { "type": "string", "traits": { @@ -5841,6 +6633,71 @@ } } }, + "com.amazonaws.customerprofiles#WorkflowAttributes": { + "type": "structure", + "members": { + "AppflowIntegration": { + "target": "com.amazonaws.customerprofiles#AppflowIntegrationWorkflowAttributes", + "traits": { + "smithy.api#documentation": "Workflow attributes specific to APPFLOW_INTEGRATION workflow.
Structure to hold workflow attributes.
" + } + }, + "com.amazonaws.customerprofiles#WorkflowList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ListWorkflowsItem" + } + }, + "com.amazonaws.customerprofiles#WorkflowMetrics": { + "type": "structure", + "members": { + "AppflowIntegration": { + "target": "com.amazonaws.customerprofiles#AppflowIntegrationWorkflowMetrics", + "traits": { + "smithy.api#documentation": "Workflow execution metrics for APPFLOW_INTEGRATION workflow.
Generic object containing workflow execution metrics.
" + } + }, + "com.amazonaws.customerprofiles#WorkflowStepItem": { + "type": "structure", + "members": { + "AppflowIntegration": { + "target": "com.amazonaws.customerprofiles#AppflowIntegrationWorkflowStep", + "traits": { + "smithy.api#documentation": "Workflow step information specific to APPFLOW_INTEGRATION workflow.
List containing steps in workflow.
" + } + }, + "com.amazonaws.customerprofiles#WorkflowStepsList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#WorkflowStepItem" + } + }, + "com.amazonaws.customerprofiles#WorkflowType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "APPFLOW_INTEGRATION", + "name": "APPFLOW_INTEGRATION" + } + ] + } + }, "com.amazonaws.customerprofiles#ZendeskConnectorOperator": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/dynamodb.json b/codegen/sdk-codegen/aws-models/dynamodb.json index 477b536d6485..2b96fc067f10 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.json @@ -3325,7 +3325,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.
" + "smithy.api#documentation": "This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.
\nFor PartiQL reads (SELECT statement), if the total number of processed\n items exceeds the maximum dataset size limit of 1 MB, the read stops and results are\n returned to the user as a LastEvaluatedKey value to continue the read in a\n subsequent operation. If the filter criteria in WHERE clause does not match\n any data, the read will return an empty result set.
A single SELECT statement response can return up to the maximum number of\n items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any\n filtering to the results using WHERE clause). If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set.
The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, along\n with a key in LastEvaluatedKey to apply in a subsequent operation so you\n can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation.
The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request. If LastEvaluatedKey is empty, then the \"last page\" of results has\n been processed and there is no more data to be retrieved. If\n LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.
Use this property to provide commands or a command script to run when you launch \n\t\t\tyour build instance.
\n\t\tThe userDataOverride property replaces any commands that Image Builder might have added to ensure\n\t\t\t\tthat Systems Manager is installed on your Linux build instance. If you override the user data,\n\t\t\t\tmake sure that you add commands to install Systems Manager, if it is not pre-installed on your\n\t\t\t\tbase image.
\n\t\tUse this property to provide commands or a command script to run when you launch \n\t\t\tyour build instance.
\n\t\tThe userDataOverride property replaces any commands that Image Builder might have added to ensure\n\t\t\tthat Systems Manager is installed on your Linux build instance. If you override the user data,\n\t\t\tmake sure that you add commands to install Systems Manager, if it is not pre-installed on your\n\t\t\tbase image.
\n\t\tThe user data is always base 64 encoded. For example, the \n\t\t\t\tfollowing commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:
\n #!/bin/bash\n
\n\t\t\tmkdir -p /var/bb/
\n\t\t\ttouch /var
\n\t\tThe data of the component.
" + "smithy.api#documentation": "Component data contains the YAML document content for the component.
" } }, "kmsKeyId": { @@ -1097,7 +1097,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new component that can be used to build, validate, test, and assess your\n\t\t\timage.
", + "smithy.api#documentation": "Creates a new component that can be used to build, validate, test, and assess your\n\t\t\timage. The component is based on a YAML document that you specify using exactly one \n\t\t\tof the following methods:
\n\t\tInline, using the data property in the request body.
A URL that points to a YAML document file stored in Amazon S3, using the \n\t\t\t\t\turi property in the request body.
The data of the component. Used to specify the data inline. Either data or\n\t\t\turi can be used to specify the data within the component.
Component data contains inline YAML document content for the component. \n\t\t\tAlternatively, you can specify the uri of a YAML document file stored in \n\t\t\tAmazon S3. However, you cannot specify both properties.
The uri of the component. Must be an Amazon S3 URL and the requester must have permission to\n\t\t\taccess the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service\n\t\t\tquota. Either data or uri can be used to specify the data within the\n\t\t\tcomponent.
The uri of a YAML component document file. This must be an S3 URL \n\t\t\t(s3://bucket/key), and the requester must have permission to access \n\t\t\tthe S3 bucket it points to. If you use Amazon S3, you can specify component content \n\t\t\tup to your service quota.
Alternatively, you can specify the YAML document inline, using the component \n\t\t\tdata property. You cannot specify both properties.
Configure export settings to deliver disk images created from your image build, \n\t\t\tusing a file format that is compatible with your VMs in that Region.
" } + }, + "fastLaunchConfigurations": { + "target": "com.amazonaws.imagebuilder#FastLaunchConfigurationList", + "traits": { + "smithy.api#documentation": "The Windows faster-launching configurations to use for AMI distribution.
" + } } }, "traits": { @@ -2919,6 +2925,97 @@ "com.amazonaws.imagebuilder#ErrorMessage": { "type": "string" }, + "com.amazonaws.imagebuilder#FastLaunchConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean that represents the current state of faster launching for the \n\t\t\tWindows AMI. Set to true to start using Windows faster launching, or \n\t\t\tfalse to stop using it.
Configuration settings for managing the number of snapshots that are \n\t\t\tcreated from pre-provisioned instances for the Windows AMI when faster \n\t\t\tlaunching is enabled.
" + } + }, + "maxParallelLaunches": { + "target": "com.amazonaws.imagebuilder#MaxParallelLaunches", + "traits": { + "smithy.api#documentation": "The maximum number of parallel instances that are launched for creating \n\t\t\tresources.
" + } + }, + "launchTemplate": { + "target": "com.amazonaws.imagebuilder#FastLaunchLaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "The launch template that the fast-launch enabled Windows AMI uses when it \n\t\t\tlaunches Windows instances to create pre-provisioned snapshots.
" + } + }, + "accountId": { + "target": "com.amazonaws.imagebuilder#AccountId", + "traits": { + "smithy.api#documentation": "The owner account ID for the fast-launch enabled Windows AMI.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Define and configure faster launching for output Windows AMIs.
" + } + }, + "com.amazonaws.imagebuilder#FastLaunchConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#FastLaunchConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.imagebuilder#FastLaunchLaunchTemplateSpecification": { + "type": "structure", + "members": { + "launchTemplateId": { + "target": "com.amazonaws.imagebuilder#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the launch template to use for faster launching for a Windows AMI.
" + } + }, + "launchTemplateName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the launch template to use for faster launching for a Windows AMI.
" + } + }, + "launchTemplateVersion": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The version of the launch template to use for faster launching for a Windows AMI.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Identifies the launch template that the associated Windows AMI uses for \n\t\t\tlaunching an instance when faster launching is enabled.
\n\t\tYou can specify either the launchTemplateName or the \n\t\t\t\tlaunchTemplateId, but not both.
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled \n\t\t\tWindows AMI.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for creating and managing pre-provisioned snapshots \n\t\t\tfor a fast-launch enabled Windows AMI.
" + } + }, "com.amazonaws.imagebuilder#Filter": { "type": "structure", "members": { @@ -6354,6 +6451,16 @@ "smithy.api#documentation": "Logging configuration defines where Image Builder uploads your logs.
" } }, + "com.amazonaws.imagebuilder#MaxParallelLaunches": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, "com.amazonaws.imagebuilder#NonEmptyString": { "type": "string", "traits": { @@ -7292,6 +7399,16 @@ "smithy.api#documentation": "The container repository where the output container image is stored.
" } }, + "com.amazonaws.imagebuilder#TargetResourceCount": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, "com.amazonaws.imagebuilder#Timezone": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/lambda.json b/codegen/sdk-codegen/aws-models/lambda.json index 1f336dd3d4e8..5d11042684ca 100644 --- a/codegen/sdk-codegen/aws-models/lambda.json +++ b/codegen/sdk-codegen/aws-models/lambda.json @@ -2951,6 +2951,42 @@ "code": 200 }, "smithy.waiters#waitable": { + "FunctionActiveV2": { + "documentation": "Waits for the function's State to be Active. This waiter uses GetFunction API. This should be used after new function creation.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Configuration.State", + "expected": "Active", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Configuration.State", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Configuration.State", + "expected": "Pending", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 1 + }, "FunctionExists": { "acceptors": [ { @@ -2967,6 +3003,42 @@ } ], "minDelay": 1 + }, + "FunctionUpdatedV2": { + "documentation": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunction API. This should be used after function updates.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Configuration.LastUpdateStatus", + "expected": "Successful", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Configuration.LastUpdateStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Configuration.LastUpdateStatus", + "expected": "InProgress", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 1 } } } @@ -3120,7 +3192,7 @@ }, "smithy.waiters#waitable": { "FunctionActive": { - "documentation": "Waits for the function's State to be Active.", + "documentation": "Waits for the function's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation.", "acceptors": [ { "state": "success", @@ -3156,7 +3228,7 @@ "minDelay": 5 }, "FunctionUpdated": { - "documentation": "Waits for the function's LastUpdateStatus to be Successful.", + "documentation": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunctionConfiguration API. This should be used after function updates.", "acceptors": [ { "state": "success", @@ -6727,6 +6799,10 @@ "value": "dotnetcore3.1", "name": "dotnetcore31" }, + { + "value": "dotnet6", + "name": "dotnet6" + }, { "value": "nodejs4.3-edge", "name": "nodejs43edge" @@ -7688,7 +7764,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed\n by a trusted publisher. For more information, see Configuring code signing.
\n \nThe function's code is locked when you publish a version. You can't modify the code of a published version,\n only the unpublished version.
\nFor a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if\n you update the image tag to a new image, Lambda does not automatically update the function.
\nUpdates a Lambda function's code. If code signing is enabled for the function, the code package must be signed\n by a trusted publisher. For more information, see Configuring code signing.
\n \nIf the function's package type is Image, you must specify the code package in ImageUri as \n the URI of a\n container image \n in the Amazon ECR registry.\n
If the function's package type is Zip, you must specify the deployment\n package as a .zip file\n archive. Enter the Amazon S3 bucket and key of the code .zip file location.\n You can also provide the function code inline using the ZipFile field.
The code in the deployment package must be compatible with the target instruction set\n architecture of the function (x86-64 or arm64).
The function's code is locked when you publish a version. You can't modify the code of a published version,\n only the unpublished version.
\nFor a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if\n you update the image tag to a new image, Lambda does not automatically update the function.
\nThe base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for\n you.
" + "smithy.api#documentation": "The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients \nhandle the encoding for you. Use only with a function defined with a .zip file archive deployment package.
" } }, "S3Bucket": { "target": "com.amazonaws.lambda#S3Bucket", "traits": { - "smithy.api#documentation": "An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.
" + "smithy.api#documentation": "An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different \nAmazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
" } }, "S3Key": { "target": "com.amazonaws.lambda#S3Key", "traits": { - "smithy.api#documentation": "The Amazon S3 key of the deployment package.
" + "smithy.api#documentation": "The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
" } }, "S3ObjectVersion": { @@ -7734,7 +7810,7 @@ "ImageUri": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "URI of a container image in the Amazon ECR registry.
" + "smithy.api#documentation": "URI of a container image in the Amazon ECR registry. Do not use for a function defined\n with a .zip file archive.
" } }, "Publish": { diff --git a/codegen/sdk-codegen/aws-models/textract.json b/codegen/sdk-codegen/aws-models/textract.json index 44d7ab403b3f..0b5eab4e1642 100644 --- a/codegen/sdk-codegen/aws-models/textract.json +++ b/codegen/sdk-codegen/aws-models/textract.json @@ -452,6 +452,14 @@ { "value": "SELECTION_ELEMENT", "name": "SELECTION_ELEMENT" + }, + { + "value": "MERGED_CELL", + "name": "MERGED_CELL" + }, + { + "value": "TITLE", + "name": "TITLE" } ] } @@ -687,6 +695,10 @@ { "value": "VALUE", "name": "VALUE" + }, + { + "value": "COLUMN_HEADER", + "name": "COLUMN_HEADER" } ] } @@ -1779,6 +1791,14 @@ { "value": "COMPLEX_FEATURES", "name": "COMPLEX_FEATURES" + }, + { + "value": "MERGED_CELL", + "name": "MERGED_CELL" + }, + { + "value": "TITLE", + "name": "TITLE" } ] } diff --git a/codegen/sdk-codegen/aws-models/transfer.json b/codegen/sdk-codegen/aws-models/transfer.json index eb92edde9747..131f95cca58e 100644 --- a/codegen/sdk-codegen/aws-models/transfer.json +++ b/codegen/sdk-codegen/aws-models/transfer.json @@ -110,13 +110,22 @@ } }, "DestinationFileLocation": { - "target": "com.amazonaws.transfer#InputFileLocation" + "target": "com.amazonaws.transfer#InputFileLocation", + "traits": { + "smithy.api#documentation": "Specifies the location for the file being copied. Only applicable for Copy type workflow\n steps. Use ${Transfer:username} in this field to parametrize the destination\n prefix by username.
A flag that indicates whether or not to overwrite an existing file of the same name.\n The default is FALSE.
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.
\nEnter ${previous.file} to use the previous file as the input.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
Timeout, in seconds, for the step.
" } + }, + "SourceFileLocation": { + "target": "com.amazonaws.transfer#SourceFileLocation", + "traits": { + "smithy.api#documentation": "Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.
\nEnter ${previous.file} to use the previous file as the input.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
The name of the step, used as an identifier.
" } + }, + "SourceFileLocation": { + "target": "com.amazonaws.transfer#SourceFileLocation", + "traits": { + "smithy.api#documentation": "Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.
\nEnter ${previous.file} to use the previous file as the input.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
Represents an object that contains entries and targets for\n HomeDirectoryMappings.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.
Represents an object that contains entries and targets for\n HomeDirectoryMappings.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
Array that contains from 1 to 10 key/value pairs.
" } + }, + "SourceFileLocation": { + "target": "com.amazonaws.transfer#SourceFileLocation", + "traits": { + "smithy.api#documentation": "Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.
\nEnter ${previous.file} to use the previous file as the input.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
A message that indicates whether the test was successful or not.
" + "smithy.api#documentation": "A message that indicates whether the test was successful or not.
\nIf an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.
\nLogical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
\nExamples:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
", + "smithy.api#documentation": "Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
\nExample address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
Generates a presigned download URL for the specified release of the mobile SDK.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
" + "smithy.api#documentation": "Generates a presigned download URL for the specified release of the mobile SDK.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" } }, "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest": { @@ -3456,7 +3456,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information for the specified mobile SDK release, including release notes and tags.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
" + "smithy.api#documentation": "Retrieves information for the specified mobile SDK release, including release notes and tags.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" } }, "com.amazonaws.wafv2#GetMobileSdkReleaseRequest": { @@ -3966,7 +3966,7 @@ "ApplicationIntegrationURL": { "target": "com.amazonaws.wafv2#OutputUrl", "traits": { - "smithy.api#documentation": "The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF application integration in the WAF Developer Guide.
The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
\nExamples:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
", + "smithy.api#documentation": "Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
\nExample address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains one or more IP addresses or blocks of IP addresses specified in Classless\n Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges\n except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.
\nWAF assigns an ARN to each IPSet that you create. To use an IP set in a\n rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
Contains zero or more IP addresses or blocks of IP addresses specified in Classless\n Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges\n except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.
\nWAF assigns an ARN to each IPSet that you create. To use an IP set in a\n rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
Retrieves a list of the available releases for the mobile SDK and the specified device platform.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
" + "smithy.api#documentation": "Retrieves a list of the available releases for the mobile SDK and the specified device platform.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" } }, "com.amazonaws.wafv2#ListMobileSdkReleasesRequest": { @@ -5208,7 +5208,7 @@ "LogDestinationConfigs": { "target": "com.amazonaws.wafv2#LogDestinationConfigs", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the logging destinations that you want to associate\n with the web ACL.
", + "smithy.api#documentation": "The logging destination configuration that you want to associate\n with the web ACL.
\nYou can associate one logging destination to a web ACL.
\nDefines an association between logging destinations and a web ACL\n resource, for logging from WAF. As part of the association, you can specify parts of\n the standard logging fields to keep out of the logs and you can specify filters so that you\n log only a subset of the logging records.
\nFor information about configuring web ACL logging destinations, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
" + "smithy.api#documentation": "Defines an association between logging destinations and a web ACL\n resource, for logging from WAF. As part of the association, you can specify parts of\n the standard logging fields to keep out of the logs and you can specify filters so that you\n log only a subset of the logging records.
\nYou can define one logging destination per web ACL.
\nYou can access information about the traffic that WAF inspects using the following\n steps:
\nCreate your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nAssociate your logging destination to your web ACL using a\n PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
" } }, "com.amazonaws.wafv2#LoggingConfigurations": { @@ -5279,7 +5279,7 @@ "LoginPath": { "target": "com.amazonaws.wafv2#LoginPathString", "traits": { - "smithy.api#documentation": "The login endpoint for your application. For example https://example.com/web/login.
The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login.
Information for a release of the mobile SDK, including release notes and tags.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF.
" + "smithy.api#documentation": "Information for a release of the mobile SDK, including release notes and tags.
\nThe mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.
" } }, "com.amazonaws.wafv2#NextMarker": { @@ -6076,7 +6076,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.
\nYou can access information about all traffic that WAF inspects using the following\n steps:
\nCreate your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nAssociate your logging destination to your web ACL using a\n PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.
\nEnables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.
\nYou can define one logging destination per web ACL.
\nYou can access information about the traffic that WAF inspects using the following\n steps:
\nCreate your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nAssociate your logging destination to your web ACL using a\n PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.
\nThis operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.
\nContains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
\nExamples:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
", + "smithy.api#documentation": "Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
\nExample address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": [] \n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n
INVALID specification: \"Addresses\": [\"\"] INVALID