Skip to content

Commit

Permalink
feat(client-opensearch): This release allows customers to list and as…
Browse files Browse the repository at this point in the history
…sociate optional plugin packages with compatible Amazon OpenSearch Service clusters for enhanced functionality.
  • Loading branch information
awstools committed Oct 16, 2023
1 parent 83809a2 commit 90dcb19
Show file tree
Hide file tree
Showing 13 changed files with 250 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export interface AssociatePackageCommandOutput extends AssociatePackageResponse,
* // DomainPackageDetails: { // DomainPackageDetails
* // PackageID: "STRING_VALUE",
* // PackageName: "STRING_VALUE",
* // PackageType: "TXT-DICTIONARY",
* // PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
* // LastUpdated: new Date("TIMESTAMP"),
* // DomainName: "STRING_VALUE",
* // DomainPackageStatus: "ASSOCIATING" || "ASSOCIATION_FAILED" || "ACTIVE" || "DISSOCIATING" || "DISSOCIATION_FAILED",
Expand Down
12 changes: 10 additions & 2 deletions clients/client-opensearch/src/commands/CreatePackageCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface CreatePackageCommandOutput extends CreatePackageResponse, __Met
* const client = new OpenSearchClient(config);
* const input = { // CreatePackageRequest
* PackageName: "STRING_VALUE", // required
* PackageType: "TXT-DICTIONARY", // required
* PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN", // required
* PackageDescription: "STRING_VALUE",
* PackageSource: { // PackageSource
* S3BucketName: "STRING_VALUE",
Expand All @@ -60,7 +60,7 @@ export interface CreatePackageCommandOutput extends CreatePackageResponse, __Met
* // PackageDetails: { // PackageDetails
* // PackageID: "STRING_VALUE",
* // PackageName: "STRING_VALUE",
* // PackageType: "TXT-DICTIONARY",
* // PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
* // PackageDescription: "STRING_VALUE",
* // PackageStatus: "COPYING" || "COPY_FAILED" || "VALIDATING" || "VALIDATION_FAILED" || "AVAILABLE" || "DELETING" || "DELETED" || "DELETE_FAILED",
* // CreatedAt: new Date("TIMESTAMP"),
Expand All @@ -70,6 +70,14 @@ export interface CreatePackageCommandOutput extends CreatePackageResponse, __Met
* // ErrorType: "STRING_VALUE",
* // ErrorMessage: "STRING_VALUE",
* // },
* // EngineVersion: "STRING_VALUE",
* // AvailablePluginProperties: { // PluginProperties
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // Version: "STRING_VALUE",
* // ClassName: "STRING_VALUE",
* // UncompressedSizeInBytes: Number("long"),
* // },
* // },
* // };
*
Expand Down
10 changes: 9 additions & 1 deletion clients/client-opensearch/src/commands/DeletePackageCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export interface DeletePackageCommandOutput extends DeletePackageResponse, __Met
* // PackageDetails: { // PackageDetails
* // PackageID: "STRING_VALUE",
* // PackageName: "STRING_VALUE",
* // PackageType: "TXT-DICTIONARY",
* // PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
* // PackageDescription: "STRING_VALUE",
* // PackageStatus: "COPYING" || "COPY_FAILED" || "VALIDATING" || "VALIDATION_FAILED" || "AVAILABLE" || "DELETING" || "DELETED" || "DELETE_FAILED",
* // CreatedAt: new Date("TIMESTAMP"),
Expand All @@ -64,6 +64,14 @@ export interface DeletePackageCommandOutput extends DeletePackageResponse, __Met
* // ErrorType: "STRING_VALUE",
* // ErrorMessage: "STRING_VALUE",
* // },
* // EngineVersion: "STRING_VALUE",
* // AvailablePluginProperties: { // PluginProperties
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // Version: "STRING_VALUE",
* // ClassName: "STRING_VALUE",
* // UncompressedSizeInBytes: Number("long"),
* // },
* // },
* // };
*
Expand Down
12 changes: 10 additions & 2 deletions clients/client-opensearch/src/commands/DescribePackagesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export interface DescribePackagesCommandOutput extends DescribePackagesResponse,
* const input = { // DescribePackagesRequest
* Filters: [ // DescribePackagesFilterList
* { // DescribePackagesFilter
* Name: "PackageID" || "PackageName" || "PackageStatus",
* Name: "PackageID" || "PackageName" || "PackageStatus" || "PackageType" || "EngineVersion",
* Value: [ // DescribePackagesFilterValues
* "STRING_VALUE",
* ],
Expand All @@ -64,7 +64,7 @@ export interface DescribePackagesCommandOutput extends DescribePackagesResponse,
* // { // PackageDetails
* // PackageID: "STRING_VALUE",
* // PackageName: "STRING_VALUE",
* // PackageType: "TXT-DICTIONARY",
* // PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
* // PackageDescription: "STRING_VALUE",
* // PackageStatus: "COPYING" || "COPY_FAILED" || "VALIDATING" || "VALIDATION_FAILED" || "AVAILABLE" || "DELETING" || "DELETED" || "DELETE_FAILED",
* // CreatedAt: new Date("TIMESTAMP"),
Expand All @@ -74,6 +74,14 @@ export interface DescribePackagesCommandOutput extends DescribePackagesResponse,
* // ErrorType: "STRING_VALUE",
* // ErrorMessage: "STRING_VALUE",
* // },
* // EngineVersion: "STRING_VALUE",
* // AvailablePluginProperties: { // PluginProperties
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // Version: "STRING_VALUE",
* // ClassName: "STRING_VALUE",
* // UncompressedSizeInBytes: Number("long"),
* // },
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export interface DissociatePackageCommandOutput extends DissociatePackageRespons
* // DomainPackageDetails: { // DomainPackageDetails
* // PackageID: "STRING_VALUE",
* // PackageName: "STRING_VALUE",
* // PackageType: "TXT-DICTIONARY",
* // PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
* // LastUpdated: new Date("TIMESTAMP"),
* // DomainName: "STRING_VALUE",
* // DomainPackageStatus: "ASSOCIATING" || "ASSOCIATION_FAILED" || "ACTIVE" || "DISSOCIATING" || "DISSOCIATION_FAILED",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ export interface GetPackageVersionHistoryCommandOutput extends GetPackageVersion
* // PackageVersion: "STRING_VALUE",
* // CommitMessage: "STRING_VALUE",
* // CreatedAt: new Date("TIMESTAMP"),
* // PluginProperties: { // PluginProperties
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // Version: "STRING_VALUE",
* // ClassName: "STRING_VALUE",
* // UncompressedSizeInBytes: Number("long"),
* // },
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export interface ListDomainsForPackageCommandOutput extends ListDomainsForPackag
* // { // DomainPackageDetails
* // PackageID: "STRING_VALUE",
* // PackageName: "STRING_VALUE",
* // PackageType: "TXT-DICTIONARY",
* // PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
* // LastUpdated: new Date("TIMESTAMP"),
* // DomainName: "STRING_VALUE",
* // DomainPackageStatus: "ASSOCIATING" || "ASSOCIATION_FAILED" || "ACTIVE" || "DISSOCIATING" || "DISSOCIATION_FAILED",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export interface ListPackagesForDomainCommandOutput extends ListPackagesForDomai
* // { // DomainPackageDetails
* // PackageID: "STRING_VALUE",
* // PackageName: "STRING_VALUE",
* // PackageType: "TXT-DICTIONARY",
* // PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
* // LastUpdated: new Date("TIMESTAMP"),
* // DomainName: "STRING_VALUE",
* // DomainPackageStatus: "ASSOCIATING" || "ASSOCIATION_FAILED" || "ACTIVE" || "DISSOCIATING" || "DISSOCIATION_FAILED",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface UpdateDomainConfigCommandOutput extends UpdateDomainConfigRespo
/**
* @public
* <p>Modifies the cluster configuration of the specified Amazon OpenSearch Service
* domain.sl</p>
* domain.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
10 changes: 9 additions & 1 deletion clients/client-opensearch/src/commands/UpdatePackageCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export interface UpdatePackageCommandOutput extends UpdatePackageResponse, __Met
* // PackageDetails: { // PackageDetails
* // PackageID: "STRING_VALUE",
* // PackageName: "STRING_VALUE",
* // PackageType: "TXT-DICTIONARY",
* // PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
* // PackageDescription: "STRING_VALUE",
* // PackageStatus: "COPYING" || "COPY_FAILED" || "VALIDATING" || "VALIDATION_FAILED" || "AVAILABLE" || "DELETING" || "DELETED" || "DELETE_FAILED",
* // CreatedAt: new Date("TIMESTAMP"),
Expand All @@ -70,6 +70,14 @@ export interface UpdatePackageCommandOutput extends UpdatePackageResponse, __Met
* // ErrorType: "STRING_VALUE",
* // ErrorMessage: "STRING_VALUE",
* // },
* // EngineVersion: "STRING_VALUE",
* // AvailablePluginProperties: { // PluginProperties
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // Version: "STRING_VALUE",
* // ClassName: "STRING_VALUE",
* // UncompressedSizeInBytes: Number("long"),
* // },
* // },
* // };
*
Expand Down
69 changes: 64 additions & 5 deletions clients/client-opensearch/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -864,6 +864,7 @@ export interface ErrorDetails {
*/
export const PackageType = {
TXT_DICTIONARY: "TXT-DICTIONARY",
ZIP_PLUGIN: "ZIP-PLUGIN",
} as const;

/**
Expand Down Expand Up @@ -2316,12 +2317,14 @@ export type SkipUnavailableStatus = (typeof SkipUnavailableStatus)[keyof typeof

/**
* @public
* <p>Cross cluster search specific connection properties.</p>
* <p>Cross-cluster search specific connection properties.</p>
*/
export interface CrossClusterSearchConnectionProperties {
/**
* @public
* <p>Status of SkipUnavailable param for outbound connection.</p>
* <p>The status of the <code>SkipUnavailable</code> setting for the outbound connection. This
* feature allows you to specify some clusters as optional and ensure that your cross-cluster
* queries return partial results despite failures on one or more remote clusters.</p>
*/
SkipUnavailable?: SkipUnavailableStatus;
}
Expand Down Expand Up @@ -2571,6 +2574,42 @@ export interface CreatePackageRequest {
PackageSource: PackageSource | undefined;
}

/**
* @public
* <p>Basic information about the plugin.</p>
*/
export interface PluginProperties {
/**
* @public
* <p>The name of the plugin.</p>
*/
Name?: string;

/**
* @public
* <p>The description of the plugin.</p>
*/
Description?: string;

/**
* @public
* <p>The version of the plugin.</p>
*/
Version?: string;

/**
* @public
* <p>The name of the class to load.</p>
*/
ClassName?: string;

/**
* @public
* <p>The uncompressed size of the plugin.</p>
*/
UncompressedSizeInBytes?: number;
}

/**
* @public
* @enum
Expand Down Expand Up @@ -2649,6 +2688,19 @@ export interface PackageDetails {
* <p>Additional information if the package is in an error state. Null otherwise.</p>
*/
ErrorDetails?: ErrorDetails;

/**
* @public
* <p>Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
* Defaults to the latest version of OpenSearch.</p>
*/
EngineVersion?: string;

/**
* @public
* <p>If the package is a <code>ZIP-PLUGIN</code> package, additional information about plugin properties.</p>
*/
AvailablePluginProperties?: PluginProperties;
}

/**
Expand Down Expand Up @@ -4133,9 +4185,8 @@ export interface DescribeDomainNodesResponse {
export interface DescribeDomainsRequest {
/**
* @public
* <p>Array of OpenSearch Service domain names that you want information about. If you don't
* specify any domains, OpenSearch Service returns information about all domains owned by the
* account.</p>
* <p>Array of OpenSearch Service domain names that you want information about. You must specify
* at least one domain name.</p>
*/
DomainNames: string[] | undefined;
}
Expand Down Expand Up @@ -4606,9 +4657,11 @@ export interface DescribeOutboundConnectionsResponse {
* @enum
*/
export const DescribePackagesFilterName = {
EngineVersion: "EngineVersion",
PackageID: "PackageID",
PackageName: "PackageName",
PackageStatus: "PackageStatus",
PackageType: "PackageType",
} as const;

/**
Expand Down Expand Up @@ -5158,6 +5211,12 @@ export interface PackageVersionHistory {
* <p>The date and time when the package was created.</p>
*/
CreatedAt?: Date;

/**
* @public
* <p>Additional information about plugin properties if the package is a <code>ZIP-PLUGIN</code> package.</p>
*/
PluginProperties?: PluginProperties;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions clients/client-opensearch/src/protocols/Aws_restJson1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5920,7 +5920,9 @@ const de_OptionStatus = (output: any, context: __SerdeContext): OptionStatus =>
const de_PackageDetails = (output: any, context: __SerdeContext): PackageDetails => {
return take(output, {
AvailablePackageVersion: __expectString,
AvailablePluginProperties: _json,
CreatedAt: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
EngineVersion: __expectString,
ErrorDetails: _json,
LastUpdatedAt: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
PackageDescription: __expectString,
Expand Down Expand Up @@ -5951,6 +5953,7 @@ const de_PackageVersionHistory = (output: any, context: __SerdeContext): Package
CommitMessage: __expectString,
CreatedAt: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
PackageVersion: __expectString,
PluginProperties: _json,
}) as any;
};

Expand All @@ -5966,6 +5969,8 @@ const de_PackageVersionHistoryList = (output: any, context: __SerdeContext): Pac
return retVal;
};

// de_PluginProperties omitted.

/**
* deserializeAws_restJson1RecurringCharge
*/
Expand Down
Loading

0 comments on commit 90dcb19

Please sign in to comment.