createPartnerEventSource method

Future<CreatePartnerEventSourceResponse> createPartnerEventSource({ required String account, required String name, })

Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers.

Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types.

A partner event source creates events based on resources within the SaaS partner's service or application.

An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets.

Partner event source names follow this format:

partner_name/event_namespace/event_name

partner_name is determined during partner registration and identifies the partner to AWS customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help AWS customers decide whether to create an event bus to receive these events.

May throw ResourceAlreadyExistsException. May throw InternalException. May throw ConcurrentModificationException. May throw LimitExceededException. May throw OperationDisabledException.

Parameter account : The AWS account ID that is permitted to create a matching partner event bus for this partner event source.

Parameter name : The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The AWS account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.

Implementation

Future<CreatePartnerEventSourceResponse> createPartnerEventSource({
  required String account,
  required String name,
}) async {
  ArgumentError.checkNotNull(account, 'account');
  _s.validateStringLength(
    'account',
    account,
    12,
    12,
    isRequired: true,
  );
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    256,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSEvents.CreatePartnerEventSource'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Account': account,
      'Name': name,
    },
  );

  return CreatePartnerEventSourceResponse.fromJson(jsonResponse.body);
}