/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / appintegrations.d.ts
appintegrations.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class AppIntegrations extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: AppIntegrations.Types.ClientConfiguration) 13 config: Config & AppIntegrations.Types.ClientConfiguration; 14 /** 15 * Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane. 16 */ 17 createEventIntegration(params: AppIntegrations.Types.CreateEventIntegrationRequest, callback?: (err: AWSError, data: AppIntegrations.Types.CreateEventIntegrationResponse) => void): Request<AppIntegrations.Types.CreateEventIntegrationResponse, AWSError>; 18 /** 19 * Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane. 20 */ 21 createEventIntegration(callback?: (err: AWSError, data: AppIntegrations.Types.CreateEventIntegrationResponse) => void): Request<AppIntegrations.Types.CreateEventIntegrationResponse, AWSError>; 22 /** 23 * Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected. 24 */ 25 deleteEventIntegration(params: AppIntegrations.Types.DeleteEventIntegrationRequest, callback?: (err: AWSError, data: AppIntegrations.Types.DeleteEventIntegrationResponse) => void): Request<AppIntegrations.Types.DeleteEventIntegrationResponse, AWSError>; 26 /** 27 * Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected. 28 */ 29 deleteEventIntegration(callback?: (err: AWSError, data: AppIntegrations.Types.DeleteEventIntegrationResponse) => void): Request<AppIntegrations.Types.DeleteEventIntegrationResponse, AWSError>; 30 /** 31 * Return information about the event integration. 32 */ 33 getEventIntegration(params: AppIntegrations.Types.GetEventIntegrationRequest, callback?: (err: AWSError, data: AppIntegrations.Types.GetEventIntegrationResponse) => void): Request<AppIntegrations.Types.GetEventIntegrationResponse, AWSError>; 34 /** 35 * Return information about the event integration. 36 */ 37 getEventIntegration(callback?: (err: AWSError, data: AppIntegrations.Types.GetEventIntegrationResponse) => void): Request<AppIntegrations.Types.GetEventIntegrationResponse, AWSError>; 38 /** 39 * Returns a paginated list of event integration associations in the account. 40 */ 41 listEventIntegrationAssociations(params: AppIntegrations.Types.ListEventIntegrationAssociationsRequest, callback?: (err: AWSError, data: AppIntegrations.Types.ListEventIntegrationAssociationsResponse) => void): Request<AppIntegrations.Types.ListEventIntegrationAssociationsResponse, AWSError>; 42 /** 43 * Returns a paginated list of event integration associations in the account. 44 */ 45 listEventIntegrationAssociations(callback?: (err: AWSError, data: AppIntegrations.Types.ListEventIntegrationAssociationsResponse) => void): Request<AppIntegrations.Types.ListEventIntegrationAssociationsResponse, AWSError>; 46 /** 47 * Returns a paginated list of event integrations in the account. 48 */ 49 listEventIntegrations(params: AppIntegrations.Types.ListEventIntegrationsRequest, callback?: (err: AWSError, data: AppIntegrations.Types.ListEventIntegrationsResponse) => void): Request<AppIntegrations.Types.ListEventIntegrationsResponse, AWSError>; 50 /** 51 * Returns a paginated list of event integrations in the account. 52 */ 53 listEventIntegrations(callback?: (err: AWSError, data: AppIntegrations.Types.ListEventIntegrationsResponse) => void): Request<AppIntegrations.Types.ListEventIntegrationsResponse, AWSError>; 54 /** 55 * Lists the tags for the specified resource. 56 */ 57 listTagsForResource(params: AppIntegrations.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppIntegrations.Types.ListTagsForResourceResponse) => void): Request<AppIntegrations.Types.ListTagsForResourceResponse, AWSError>; 58 /** 59 * Lists the tags for the specified resource. 60 */ 61 listTagsForResource(callback?: (err: AWSError, data: AppIntegrations.Types.ListTagsForResourceResponse) => void): Request<AppIntegrations.Types.ListTagsForResourceResponse, AWSError>; 62 /** 63 * Adds the specified tags to the specified resource. 64 */ 65 tagResource(params: AppIntegrations.Types.TagResourceRequest, callback?: (err: AWSError, data: AppIntegrations.Types.TagResourceResponse) => void): Request<AppIntegrations.Types.TagResourceResponse, AWSError>; 66 /** 67 * Adds the specified tags to the specified resource. 68 */ 69 tagResource(callback?: (err: AWSError, data: AppIntegrations.Types.TagResourceResponse) => void): Request<AppIntegrations.Types.TagResourceResponse, AWSError>; 70 /** 71 * Removes the specified tags from the specified resource. 72 */ 73 untagResource(params: AppIntegrations.Types.UntagResourceRequest, callback?: (err: AWSError, data: AppIntegrations.Types.UntagResourceResponse) => void): Request<AppIntegrations.Types.UntagResourceResponse, AWSError>; 74 /** 75 * Removes the specified tags from the specified resource. 76 */ 77 untagResource(callback?: (err: AWSError, data: AppIntegrations.Types.UntagResourceResponse) => void): Request<AppIntegrations.Types.UntagResourceResponse, AWSError>; 78 /** 79 * Updates the description of an event integration. 80 */ 81 updateEventIntegration(params: AppIntegrations.Types.UpdateEventIntegrationRequest, callback?: (err: AWSError, data: AppIntegrations.Types.UpdateEventIntegrationResponse) => void): Request<AppIntegrations.Types.UpdateEventIntegrationResponse, AWSError>; 82 /** 83 * Updates the description of an event integration. 84 */ 85 updateEventIntegration(callback?: (err: AWSError, data: AppIntegrations.Types.UpdateEventIntegrationResponse) => void): Request<AppIntegrations.Types.UpdateEventIntegrationResponse, AWSError>; 86 } 87 declare namespace AppIntegrations { 88 export type Arn = string; 89 export type ClientAssociationMetadata = {[key: string]: NonBlankString}; 90 export type ClientId = string; 91 export interface CreateEventIntegrationRequest { 92 /** 93 * The name of the event integration. 94 */ 95 Name: Name; 96 /** 97 * The description of the event integration. 98 */ 99 Description?: Description; 100 /** 101 * The event filter. 102 */ 103 EventFilter: EventFilter; 104 /** 105 * The EventBridge bus. 106 */ 107 EventBridgeBus: EventBridgeBus; 108 /** 109 * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. 110 */ 111 ClientToken?: IdempotencyToken; 112 /** 113 * One or more tags. 114 */ 115 Tags?: TagMap; 116 } 117 export interface CreateEventIntegrationResponse { 118 /** 119 * The Amazon Resource Name (ARN) of the event integration. 120 */ 121 EventIntegrationArn?: Arn; 122 } 123 export interface DeleteEventIntegrationRequest { 124 /** 125 * The name of the event integration. 126 */ 127 Name: Name; 128 } 129 export interface DeleteEventIntegrationResponse { 130 } 131 export type Description = string; 132 export type EventBridgeBus = string; 133 export type EventBridgeRuleName = string; 134 export interface EventFilter { 135 /** 136 * The source of the events. 137 */ 138 Source: Source; 139 } 140 export interface EventIntegration { 141 /** 142 * The Amazon Resource Name (ARN) of the event integration. 143 */ 144 EventIntegrationArn?: Arn; 145 /** 146 * The name of the event integration. 147 */ 148 Name?: Name; 149 /** 150 * The event integration description. 151 */ 152 Description?: Description; 153 /** 154 * The event integration filter. 155 */ 156 EventFilter?: EventFilter; 157 /** 158 * The Amazon EventBridge bus for the event integration. 159 */ 160 EventBridgeBus?: EventBridgeBus; 161 /** 162 * The tags. 163 */ 164 Tags?: TagMap; 165 } 166 export interface EventIntegrationAssociation { 167 /** 168 * The Amazon Resource Name (ARN) for the event integration association. 169 */ 170 EventIntegrationAssociationArn?: Arn; 171 /** 172 * The identifier for the event integration association. 173 */ 174 EventIntegrationAssociationId?: UUID; 175 /** 176 * The name of the event integration. 177 */ 178 EventIntegrationName?: Name; 179 /** 180 * The identifier for the client that is associated with the event integration. 181 */ 182 ClientId?: ClientId; 183 /** 184 * The name of the EventBridge rule. 185 */ 186 EventBridgeRuleName?: EventBridgeRuleName; 187 /** 188 * The metadata associated with the client. 189 */ 190 ClientAssociationMetadata?: ClientAssociationMetadata; 191 } 192 export type EventIntegrationAssociationsList = EventIntegrationAssociation[]; 193 export type EventIntegrationsList = EventIntegration[]; 194 export interface GetEventIntegrationRequest { 195 /** 196 * The name of the event integration. 197 */ 198 Name: Name; 199 } 200 export interface GetEventIntegrationResponse { 201 /** 202 * The name of the event integration. 203 */ 204 Name?: Name; 205 /** 206 * The description of the event integration. 207 */ 208 Description?: Description; 209 /** 210 * The Amazon Resource Name (ARN) for the event integration. 211 */ 212 EventIntegrationArn?: Arn; 213 /** 214 * The EventBridge bus. 215 */ 216 EventBridgeBus?: EventBridgeBus; 217 /** 218 * The event filter. 219 */ 220 EventFilter?: EventFilter; 221 /** 222 * One or more tags. 223 */ 224 Tags?: TagMap; 225 } 226 export type IdempotencyToken = string; 227 export interface ListEventIntegrationAssociationsRequest { 228 /** 229 * The name of the event integration. 230 */ 231 EventIntegrationName: Name; 232 /** 233 * 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. 234 */ 235 NextToken?: NextToken; 236 /** 237 * The maximum number of results to return per page. 238 */ 239 MaxResults?: MaxResults; 240 } 241 export interface ListEventIntegrationAssociationsResponse { 242 /** 243 * The event integration associations. 244 */ 245 EventIntegrationAssociations?: EventIntegrationAssociationsList; 246 /** 247 * If there are additional results, this is the token for the next set of results. 248 */ 249 NextToken?: NextToken; 250 } 251 export interface ListEventIntegrationsRequest { 252 /** 253 * 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. 254 */ 255 NextToken?: NextToken; 256 /** 257 * The maximum number of results to return per page. 258 */ 259 MaxResults?: MaxResults; 260 } 261 export interface ListEventIntegrationsResponse { 262 /** 263 * The event integrations. 264 */ 265 EventIntegrations?: EventIntegrationsList; 266 /** 267 * If there are additional results, this is the token for the next set of results. 268 */ 269 NextToken?: NextToken; 270 } 271 export interface ListTagsForResourceRequest { 272 /** 273 * The Amazon Resource Name (ARN) of the resource. 274 */ 275 resourceArn: Arn; 276 } 277 export interface ListTagsForResourceResponse { 278 /** 279 * Information about the tags. 280 */ 281 tags?: TagMap; 282 } 283 export type MaxResults = number; 284 export type Name = string; 285 export type NextToken = string; 286 export type NonBlankString = string; 287 export type Source = string; 288 export type TagKey = string; 289 export type TagKeyList = TagKey[]; 290 export type TagMap = {[key: string]: TagValue}; 291 export interface TagResourceRequest { 292 /** 293 * The Amazon Resource Name (ARN) of the resource. 294 */ 295 resourceArn: Arn; 296 /** 297 * One or more tags. 298 */ 299 tags: TagMap; 300 } 301 export interface TagResourceResponse { 302 } 303 export type TagValue = string; 304 export type UUID = string; 305 export interface UntagResourceRequest { 306 /** 307 * The Amazon Resource Name (ARN) of the resource. 308 */ 309 resourceArn: Arn; 310 /** 311 * The tag keys. 312 */ 313 tagKeys: TagKeyList; 314 } 315 export interface UntagResourceResponse { 316 } 317 export interface UpdateEventIntegrationRequest { 318 /** 319 * The name of the event integration. 320 */ 321 Name: Name; 322 /** 323 * The description of the event inegration. 324 */ 325 Description?: Description; 326 } 327 export interface UpdateEventIntegrationResponse { 328 } 329 /** 330 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 331 */ 332 export type apiVersion = "2020-07-29"|"latest"|string; 333 export interface ClientApiVersions { 334 /** 335 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 336 */ 337 apiVersion?: apiVersion; 338 } 339 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 340 /** 341 * Contains interfaces for use with the AppIntegrations client. 342 */ 343 export import Types = AppIntegrations; 344 } 345 export = AppIntegrations;