@aws-sdk/client-appsync 3.338.0 → 3.341.0

package/dist-types/models/models_0.d.ts

@@ -668,6 +668,209 @@ export declare class NotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const MergeType: {
+    readonly AUTO_MERGE: "AUTO_MERGE";
+    readonly MANUAL_MERGE: "MANUAL_MERGE";
+};
+/**
+ * @public
+ */
+export type MergeType = (typeof MergeType)[keyof typeof MergeType];
+/**
+ * @public
+ * <p>Describes properties used to specify configurations related to a source API.</p>
+ */
+export interface SourceApiAssociationConfig {
+    /**
+     * <p>The property that indicates which merging option is enabled in the source API association.</p>
+     *          <p>Valid merge types are <code>MANUAL_MERGE</code> (default) and <code>AUTO_MERGE</code>. Manual merges are the
+     *          default behavior and require the user to trigger any changes from the source APIs to the merged API manually.
+     *          Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the
+     *          source APIs are also made to the merged API. Auto merges use <code>MergedApiExecutionRoleArn</code> to perform
+     *          merge operations.</p>
+     */
+    mergeType?: MergeType | string;
+}
+/**
+ * @public
+ */
+export interface AssociateMergedGraphqlApiRequest {
+    /**
+     * <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source
+     *          APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs
+     *          from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</p>
+     */
+    sourceApiIdentifier: string | undefined;
+    /**
+     * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
+     */
+    mergedApiIdentifier: string | undefined;
+    /**
+     * <p>The description field.</p>
+     */
+    description?: string;
+    /**
+     * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
+     */
+    sourceApiAssociationConfig?: SourceApiAssociationConfig;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SourceApiAssociationStatus: {
+    readonly AUTO_MERGE_SCHEDULE_FAILED: "AUTO_MERGE_SCHEDULE_FAILED";
+    readonly DELETION_FAILED: "DELETION_FAILED";
+    readonly DELETION_IN_PROGRESS: "DELETION_IN_PROGRESS";
+    readonly DELETION_SCHEDULED: "DELETION_SCHEDULED";
+    readonly MERGE_FAILED: "MERGE_FAILED";
+    readonly MERGE_IN_PROGRESS: "MERGE_IN_PROGRESS";
+    readonly MERGE_SCHEDULED: "MERGE_SCHEDULED";
+    readonly MERGE_SUCCESS: "MERGE_SUCCESS";
+};
+/**
+ * @public
+ */
+export type SourceApiAssociationStatus = (typeof SourceApiAssociationStatus)[keyof typeof SourceApiAssociationStatus];
+/**
+ * @public
+ * <p>Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API.
+ *          There can be multiple source APIs attached to each merged API.
+ *          When linked to a merged API, the source API's schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API.
+ *          </p>
+ *          <p>Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access Manager. For more
+ *          information about sharing resources from other accounts, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/what-is.html">What is Amazon Web Services Resource Access
+ *             Manager?</a> in the <i>Amazon Web Services Resource Access Manager</i> guide.</p>
+ */
+export interface SourceApiAssociation {
+    /**
+     * <p>The ID generated by the AppSync service for the source API association.</p>
+     */
+    associationId?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the source API association.</p>
+     */
+    associationArn?: string;
+    /**
+     * <p>The ID of the AppSync source API.</p>
+     */
+    sourceApiId?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the AppSync source API.</p>
+     */
+    sourceApiArn?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the AppSync Merged API.</p>
+     */
+    mergedApiArn?: string;
+    /**
+     * <p>The ID of the AppSync Merged API.</p>
+     */
+    mergedApiId?: string;
+    /**
+     * <p>The description field.</p>
+     */
+    description?: string;
+    /**
+     * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
+     */
+    sourceApiAssociationConfig?: SourceApiAssociationConfig;
+    /**
+     * <p>The state of the source API association.</p>
+     */
+    sourceApiAssociationStatus?: SourceApiAssociationStatus | string;
+    /**
+     * <p>The detailed message related to the current state of the source API association.</p>
+     */
+    sourceApiAssociationStatusDetail?: string;
+    /**
+     * <p>The datetime value of the last successful merge of the source API association. The result will be in UTC
+     *          format and your local time zone.</p>
+     */
+    lastSuccessfulMergeDate?: Date;
+}
+/**
+ * @public
+ */
+export interface AssociateMergedGraphqlApiResponse {
+    /**
+     * <p>The <code>SourceApiAssociation</code> object data.</p>
+     */
+    sourceApiAssociation?: SourceApiAssociation;
+}
+/**
+ * @public
+ * <p>Another modification is in progress at this time and it must complete before you can
+ *          make your change.</p>
+ */
+export declare class ConcurrentModificationException extends __BaseException {
+    readonly name: "ConcurrentModificationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
+}
+/**
+ * @public
+ * <p>The request exceeded a limit. Try your request again.</p>
+ */
+export declare class LimitExceededException extends __BaseException {
+    readonly name: "LimitExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
+}
+/**
+ * @public
+ * <p>You aren't authorized to perform this operation.</p>
+ */
+export declare class UnauthorizedException extends __BaseException {
+    readonly name: "UnauthorizedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface AssociateSourceGraphqlApiRequest {
+    /**
+     * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
+     */
+    mergedApiIdentifier: string | undefined;
+    /**
+     * <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source
+     *          APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs
+     *          from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</p>
+     */
+    sourceApiIdentifier: string | undefined;
+    /**
+     * <p>The description field.</p>
+     */
+    description?: string;
+    /**
+     * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
+     */
+    sourceApiAssociationConfig?: SourceApiAssociationConfig;
+}
+/**
+ * @public
+ */
+export interface AssociateSourceGraphqlApiResponse {
+    /**
+     * <p>The <code>SourceApiAssociation</code> object data.</p>
+     */
+    sourceApiAssociation?: SourceApiAssociation;
+}
 /**
  * @public
  * @enum
@@ -714,19 +917,6 @@ export interface AuthorizationConfig {
      */
     awsIamConfig?: AwsIamConfig;
 }
-/**
- * @public
- * <p>Another modification is in progress at this time and it must complete before you can
- *          make your change.</p>
- */
-export declare class ConcurrentModificationException extends __BaseException {
-    readonly name: "ConcurrentModificationException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
-}
 /**
  * @public
  * <p>Represents the input of a <code>CreateApiCache</code> operation.</p>
@@ -854,18 +1044,6 @@ export interface CreateApiCacheResponse {
      */
     apiCache?: ApiCache;
 }
-/**
- * @public
- * <p>You aren't authorized to perform this operation.</p>
- */
-export declare class UnauthorizedException extends __BaseException {
-    readonly name: "UnauthorizedException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
-}
 /**
  * @public
  */
@@ -894,18 +1072,6 @@ export interface CreateApiKeyResponse {
      */
     apiKey?: ApiKey;
 }
-/**
- * @public
- * <p>The request exceeded a limit. Try your request again.</p>
- */
-export declare class LimitExceededException extends __BaseException {
-    readonly name: "LimitExceededException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
-}
 /**
  * @public
  * <p>Describes a Delta Sync configuration.</p>
@@ -1534,6 +1700,18 @@ export interface CreateFunctionResponse {
      */
     functionConfiguration?: FunctionConfiguration;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const GraphQLApiType: {
+    readonly GRAPHQL: "GRAPHQL";
+    readonly MERGED: "MERGED";
+};
+/**
+ * @public
+ */
+export type GraphQLApiType = (typeof GraphQLApiType)[keyof typeof GraphQLApiType];
 /**
  * @public
  * @enum
@@ -1702,6 +1880,23 @@ export interface CreateGraphqlApiRequest {
      *          once the API has been created.</p>
      */
     visibility?: GraphQLApiVisibility | string;
+    /**
+     * <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
+     *          (<code>MERGED</code>).</p>
+     */
+    apiType?: GraphQLApiType | string;
+    /**
+     * <p>The Identity and Access Management service role ARN for a merged API. The AppSync
+     *          service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to
+     *          prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes
+     *          automatically.</p>
+     */
+    mergedApiExecutionRoleArn?: string;
+    /**
+     * <p>The owner contact information for an API resource.</p>
+     *          <p>This field accepts any string input with a length of 0 - 256 characters.</p>
+     */
+    ownerContact?: string;
 }
 /**
  * @public
@@ -1773,6 +1968,27 @@ export interface GraphqlApi {
      *          once the API has been created.</p>
      */
     visibility?: GraphQLApiVisibility | string;
+    /**
+     * <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
+     *          (<code>MERGED</code>).</p>
+     */
+    apiType?: GraphQLApiType | string;
+    /**
+     * <p>The Identity and Access Management service role ARN for a merged API. The AppSync
+     *          service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to
+     *          prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes
+     *          automatically.</p>
+     */
+    mergedApiExecutionRoleArn?: string;
+    /**
+     * <p>The account owner of the GraphQL API.</p>
+     */
+    owner?: string;
+    /**
+     * <p>The owner contact information for an API resource.</p>
+     *          <p>This field accepts any string input with a length of 0 - 256 characters.</p>
+     */
+    ownerContact?: string;
 }
 /**
  * @public
@@ -2206,6 +2422,52 @@ export interface DisassociateApiRequest {
  */
 export interface DisassociateApiResponse {
 }
+/**
+ * @public
+ */
+export interface DisassociateMergedGraphqlApiRequest {
+    /**
+     * <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source
+     *          APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs
+     *          from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</p>
+     */
+    sourceApiIdentifier: string | undefined;
+    /**
+     * <p>The ID generated by the AppSync service for the source API association.</p>
+     */
+    associationId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DisassociateMergedGraphqlApiResponse {
+    /**
+     * <p>The state of the source API association.</p>
+     */
+    sourceApiAssociationStatus?: SourceApiAssociationStatus | string;
+}
+/**
+ * @public
+ */
+export interface DisassociateSourceGraphqlApiRequest {
+    /**
+     * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
+     */
+    mergedApiIdentifier: string | undefined;
+    /**
+     * <p>The ID generated by the AppSync service for the source API association.</p>
+     */
+    associationId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DisassociateSourceGraphqlApiResponse {
+    /**
+     * <p>The state of the source API association.</p>
+     */
+    sourceApiAssociationStatus?: SourceApiAssociationStatus | string;
+}
 /**
  * @public
  */
@@ -2559,6 +2821,28 @@ export interface GetSchemaCreationStatusResponse {
      */
     details?: string;
 }
+/**
+ * @public
+ */
+export interface GetSourceApiAssociationRequest {
+    /**
+     * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
+     */
+    mergedApiIdentifier: string | undefined;
+    /**
+     * <p>The ID generated by the AppSync service for the source API association.</p>
+     */
+    associationId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetSourceApiAssociationResponse {
+    /**
+     * <p>The <code>SourceApiAssociation</code> object data.</p>
+     */
+    sourceApiAssociation?: SourceApiAssociation;
+}
 /**
  * @public
  */
@@ -2654,7 +2938,8 @@ export interface ListDataSourcesResponse {
  */
 export interface ListDomainNamesRequest {
     /**
-     * <p>The API token.</p>
+     * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
+     *          next set of items in the list.</p>
      */
     nextToken?: string;
     /**
@@ -2671,7 +2956,8 @@ export interface ListDomainNamesResponse {
      */
     domainNameConfigs?: DomainNameConfig[];
     /**
-     * <p>The API token.</p>
+     * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
+     *          next set of items in the list.</p>
      */
     nextToken?: string;
 }
@@ -2707,6 +2993,18 @@ export interface ListFunctionsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const Ownership: {
+    readonly CURRENT_ACCOUNT: "CURRENT_ACCOUNT";
+    readonly OTHER_ACCOUNTS: "OTHER_ACCOUNTS";
+};
+/**
+ * @public
+ */
+export type Ownership = (typeof Ownership)[keyof typeof Ownership];
 /**
  * @public
  */
@@ -2720,6 +3018,15 @@ export interface ListGraphqlApisRequest {
      * <p>The maximum number of results that you want the request to return.</p>
      */
     maxResults?: number;
+    /**
+     * <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
+     *          (<code>MERGED</code>).</p>
+     */
+    apiType?: GraphQLApiType | string;
+    /**
+     * <p>The account owner of the GraphQL API.</p>
+     */
+    owner?: Ownership | string;
 }
 /**
  * @public
@@ -2806,6 +3113,72 @@ export interface ListResolversByFunctionResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
+export interface ListSourceApiAssociationsRequest {
+    /**
+     * <p>The API ID.</p>
+     */
+    apiId: string | undefined;
+    /**
+     * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
+     *          next set of items in the list.</p>
+     */
+    nextToken?: string;
+    /**
+     * <p>The maximum number of results that you want the request to return.</p>
+     */
+    maxResults?: number;
+}
+/**
+ * @public
+ * <p>Describes the ARNs and IDs of associations, Merged APIs, and source APIs.</p>
+ */
+export interface SourceApiAssociationSummary {
+    /**
+     * <p>The ID generated by the AppSync service for the source API association.</p>
+     */
+    associationId?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the source API association.</p>
+     */
+    associationArn?: string;
+    /**
+     * <p>The ID of the AppSync source API.</p>
+     */
+    sourceApiId?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the AppSync Source API.</p>
+     */
+    sourceApiArn?: string;
+    /**
+     * <p>The ID of the AppSync Merged API.</p>
+     */
+    mergedApiId?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the AppSync Merged API.</p>
+     */
+    mergedApiArn?: string;
+    /**
+     * <p>The description field.</p>
+     */
+    description?: string;
+}
+/**
+ * @public
+ */
+export interface ListSourceApiAssociationsResponse {
+    /**
+     * <p>The <code>SourceApiAssociationSummary</code> object data.</p>
+     */
+    sourceApiAssociationSummaries?: SourceApiAssociationSummary[];
+    /**
+     * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
+     *          next set of items in the list.</p>
+     */
+    nextToken?: string;
+}
 /**
  * @public
  */
@@ -2860,6 +3233,46 @@ export interface ListTypesResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
+export interface ListTypesByAssociationRequest {
+    /**
+     * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
+     */
+    mergedApiIdentifier: string | undefined;
+    /**
+     * <p>The ID generated by the AppSync service for the source API association.</p>
+     */
+    associationId: string | undefined;
+    /**
+     * <p>The format type.</p>
+     */
+    format: TypeDefinitionFormat | string | undefined;
+    /**
+     * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
+     *          next set of items in the list.</p>
+     */
+    nextToken?: string;
+    /**
+     * <p>The maximum number of results that you want the request to return.</p>
+     */
+    maxResults?: number;
+}
+/**
+ * @public
+ */
+export interface ListTypesByAssociationResponse {
+    /**
+     * <p>The <code>Type</code> objects.</p>
+     */
+    types?: Type[];
+    /**
+     * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
+     *          next set of items in the list.</p>
+     */
+    nextToken?: string;
+}
 /**
  * @public
  */
@@ -2883,6 +3296,28 @@ export interface StartSchemaCreationResponse {
      */
     status?: SchemaStatus | string;
 }
+/**
+ * @public
+ */
+export interface StartSchemaMergeRequest {
+    /**
+     * <p>The ID generated by the AppSync service for the source API association.</p>
+     */
+    associationId: string | undefined;
+    /**
+     * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
+     */
+    mergedApiIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface StartSchemaMergeResponse {
+    /**
+     * <p>The state of the source API association.</p>
+     */
+    sourceApiAssociationStatus?: SourceApiAssociationStatus | string;
+}
 /**
  * @public
  */
@@ -3268,6 +3703,18 @@ export interface UpdateGraphqlApiRequest {
      * <p>Configuration for Lambda function authorization.</p>
      */
     lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
+    /**
+     * <p>The Identity and Access Management service role ARN for a merged API. The AppSync
+     *          service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to
+     *          prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes
+     *          automatically.</p>
+     */
+    mergedApiExecutionRoleArn?: string;
+    /**
+     * <p>The owner contact information for an API resource.</p>
+     *          <p>This field accepts any string input with a length of 0 - 256 characters.</p>
+     */
+    ownerContact?: string;
 }
 /**
  * @public
@@ -3368,6 +3815,36 @@ export interface UpdateResolverResponse {
      */
     resolver?: Resolver;
 }
+/**
+ * @public
+ */
+export interface UpdateSourceApiAssociationRequest {
+    /**
+     * <p>The ID generated by the AppSync service for the source API association.</p>
+     */
+    associationId: string | undefined;
+    /**
+     * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
+     */
+    mergedApiIdentifier: string | undefined;
+    /**
+     * <p>The description field.</p>
+     */
+    description?: string;
+    /**
+     * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
+     */
+    sourceApiAssociationConfig?: SourceApiAssociationConfig;
+}
+/**
+ * @public
+ */
+export interface UpdateSourceApiAssociationResponse {
+    /**
+     * <p>The <code>SourceApiAssociation</code> object data.</p>
+     */
+    sourceApiAssociation?: SourceApiAssociation;
+}
 /**
  * @public
  */