Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sources): update documentation #1467

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

aws-cdk-automation
Copy link
Contributor

⚠️ This Pull Request updates daily and will overwrite all manual changes pushed to the branch

Updates the documentation source from upstream. See details in workflow run.


Automatically created by projen via the "update-source-documentation" workflow

> ⚠️ This Pull Request updates daily and will overwrite **all** manual changes pushed to the branch

Updates the documentation source from upstream. See details in [workflow run].

[Workflow Run]: https://github.com/cdklabs/awscdk-service-spec/actions/runs/12112097907

------

*Automatically created by projen via the "update-source-documentation" workflow*

Signed-off-by: github-actions <[email protected]>
Copy link

github-actions bot commented Dec 2, 2024

To work on this Pull Request, please create a new branch and PR. This prevents your work from being deleted by the automation.

Run the following commands inside the repo:

gh co 1467
git switch -c fix-pr-1467 && git push -u origin HEAD
gh pr create -t "fix: PR #1467" --body "Fixes https://github.com/cdklabs/awscdk-service-spec/pull/1467"

Copy link

github-actions bot commented Dec 2, 2024

@aws-cdk/aws-service-spec: Model database diff detected

├[~] service aws-apigateway
│ └ resources
│    └[~] resource AWS::ApiGateway::DomainNameV2
│      └ properties
│         └ ManagementPolicy: (documentation changed)
├[~] service aws-cognito
│ └ resources
│    ├[~] resource AWS::Cognito::ManagedLoginBranding
│    │ ├  - documentation: Resource Type definition for AWS::Cognito::ManagedLoginBranding
│    │ │  + documentation: Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding designer.
│    │ │  Provides values for UI customization in a `Settings` JSON object and image files in an `Assets` array. To send the JSON object `Document` type parameter in `Settings` , you might need to update to the most recent version of your AWS SDK.
│    │ │  This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
│    │ │  As a best practice, modify the output of [DescribeManagedLoginBrandingByClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBrandingByClient.html) into the request parameters for this operation. To get all settings, set `ReturnMergedResources` to `true` . For more information, see [API and SDK operations for managed login branding](https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-brandingdesigner.html#branding-designer-api)
│    │ │  > Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
│    │ │  > 
│    │ │  > **Learn more** - [Signing AWS API Requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)
│    │ │  > - [Using the Amazon Cognito user pools API and user pool endpoints](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)
│    │ ├ properties
│    │ │  ├ Assets: (documentation changed)
│    │ │  ├ Settings: (documentation changed)
│    │ │  ├ UseCognitoProvidedValues: (documentation changed)
│    │ │  └ UserPoolId: (documentation changed)
│    │ ├ attributes
│    │ │  └ ManagedLoginBrandingId: (documentation changed)
│    │ └ types
│    │    └[~] type AssetType
│    │      ├  - documentation: undefined
│    │      │  + documentation: An image file from a managed login branding style in a user pool.
│    │      │  This data type is a request parameter of [CreateManagedLoginBranding](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateManagedLoginBranding.html) and [UpdateManagedLoginBranding](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateManagedLoginBranding.html) , and a response parameter of [DescribeManagedLoginBranding](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBranding.html) .
│    │      └ properties
│    │         ├ Bytes: (documentation changed)
│    │         ├ Category: (documentation changed)
│    │         ├ ColorMode: (documentation changed)
│    │         ├ Extension: (documentation changed)
│    │         └ ResourceId: (documentation changed)
│    └[~] resource AWS::Cognito::UserPool
│      └ properties
│         └ UserPoolTier: (documentation changed)
├[~] service aws-config
│ └ resources
│    └[~] resource AWS::Config::ConfigurationRecorder
│      └ properties
│         └ RecordingMode: (documentation changed)
└[~] service aws-wisdom
  └ resources
     └[~] resource AWS::Wisdom::KnowledgeBase
       ├ properties
       │  └ VectorIngestionConfiguration: (documentation changed)
       └ types
          ├[~] type ChunkingConfiguration
          │ ├  - documentation: undefined
          │ │  + documentation: Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
          │ └ properties
          │    ├ ChunkingStrategy: (documentation changed)
          │    ├ FixedSizeChunkingConfiguration: (documentation changed)
          │    ├ HierarchicalChunkingConfiguration: (documentation changed)
          │    └ SemanticChunkingConfiguration: (documentation changed)
          ├[~] type FixedSizeChunkingConfiguration
          │ ├  - documentation: undefined
          │ │  + documentation: Configurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE` , exclude this field.
          │ └ properties
          │    ├ MaxTokens: (documentation changed)
          │    └ OverlapPercentage: (documentation changed)
          ├[~] type HierarchicalChunkingConfiguration
          │ ├  - documentation: undefined
          │ │  + documentation: Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
          │ └ properties
          │    ├ LevelConfigurations: (documentation changed)
          │    └ OverlapTokens: (documentation changed)
          ├[~] type HierarchicalChunkingLevelConfiguration
          │ ├  - documentation: undefined
          │ │  + documentation: Token settings for each layer.
          │ └ properties
          │    └ MaxTokens: (documentation changed)
          ├[~] type ManagedSourceConfiguration
          │ ├  - documentation: undefined
          │ │  + documentation: Source configuration for managed resources.
          │ └ properties
          │    └ WebCrawlerConfiguration: (documentation changed)
          ├[~] type ParsingConfiguration
          │ ├  - documentation: undefined
          │ │  + documentation: Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.
          │ └ properties
          │    ├ BedrockFoundationModelConfiguration: (documentation changed)
          │    └ ParsingStrategy: (documentation changed)
          ├[~] type ParsingPrompt
          │ ├  - documentation: undefined
          │ │  + documentation: Instructions for interpreting the contents of a document.
          │ └ properties
          │    └ ParsingPromptText: (documentation changed)
          ├[~] type SeedUrl
          │ ├  - documentation: undefined
          │ │  + documentation: A URL for crawling.
          │ └ properties
          │    └ Url: (documentation changed)
          ├[~] type SemanticChunkingConfiguration
          │ ├  - documentation: undefined
          │ │  + documentation: Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
          │ └ properties
          │    ├ BreakpointPercentileThreshold: (documentation changed)
          │    ├ BufferSize: (documentation changed)
          │    └ MaxTokens: (documentation changed)
          ├[~] type SourceConfiguration
          │ └ properties
          │    └ ManagedSourceConfiguration: (documentation changed)
          ├[~] type UrlConfiguration
          │ ├  - documentation: undefined
          │ │  + documentation: The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
          │ └ properties
          │    └ SeedUrls: (documentation changed)
          ├[~] type VectorIngestionConfiguration
          │ ├  - documentation: undefined
          │ │  + documentation: Contains details about how to ingest the documents in a data source.
          │ └ properties
          │    ├ ChunkingConfiguration: (documentation changed)
          │    └ ParsingConfiguration: (documentation changed)
          └[~] type WebCrawlerConfiguration
            ├  - documentation: undefined
            │  + documentation: The configuration details for the web data source.
            └ properties
               ├ CrawlerLimits: (documentation changed)
               ├ ExclusionFilters: (documentation changed)
               ├ InclusionFilters: (documentation changed)
               ├ Scope: (documentation changed)
               └ UrlConfiguration: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Dec 2, 2024
Merged via the queue into main with commit 80b56c2 Dec 2, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch December 2, 2024 03:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant