sip_media_applications

Creates, updates, deletes, gets or lists a sip_media_applications resource.

Overview

Name	sip_media_applications
Type	Resource
Id	aws.chime_sdk_voice.sip_media_applications

Fields

The following fields are returned by SELECT queries:

get_sip_media_application

Name	Datatype	Description
aws_region	string	The AWS Region in which the SIP media application is created.
created_timestamp	string (date-time)	The SIP media application creation timestamp, in ISO 8601 format.
endpoints	array	List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.
name	string	The SIP media application's name. (pattern: <code>[a-zA-Z0-9 _.-]+</code>)
sip_media_application_arn	string	The ARN of the SIP media application. (pattern: <code>.\S.</code>)
sip_media_application_id	string	A SIP media application's ID. (pattern: <code>.\S.</code>)
updated_timestamp	string (date-time)	The time at which the SIP media application was updated.

list_sip_media_applications

Name	Datatype	Description
aws_region	string	The AWS Region in which the SIP media application is created.
created_timestamp	string (date-time)	The SIP media application creation timestamp, in ISO 8601 format.
endpoints	array	List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.
name	string	The SIP media application's name. (pattern: <code>[a-zA-Z0-9 _.-]+</code>)
sip_media_application_arn	string	The ARN of the SIP media application. (pattern: <code>.\S.</code>)
sip_media_application_id	string	A SIP media application's ID. (pattern: <code>.\S.</code>)
updated_timestamp	string (date-time)	The time at which the SIP media application was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sip_media_application	select	sip_media_application_id, region		Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
list_sip_media_applications	select	region	max-results, next-token	Lists the SIP media applications under the administrator's AWS account.
create_sip_media_application_call	insert	sip_media_application_id, region, FromPhoneNumber, ToPhoneNumber		Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.
create_sip_media_application	insert	region, AwsRegion		Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.
update_sip_media_application_call	update	sip_media_application_id, transaction_id, region, Arguments		Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.
update_sip_media_application	update	sip_media_application_id, region		Updates the details of the specified SIP media application.
delete_sip_media_application	delete	sip_media_application_id, region		Deletes a SIP media application.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
sip_media_application_id	string	The SIP media application ID.
transaction_id	string	The ID of the call transaction.
max-results	integer	The maximum number of results to return in a single call. Defaults to 100.
next-token	string	The token used to return the next page of results.

SELECT examples

get_sip_media_application

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

SELECT
aws_region,
created_timestamp,
endpoints,
name,
sip_media_application_arn,
sip_media_application_id,
updated_timestamp
FROM aws.chime_sdk_voice.sip_media_applications
WHERE sip_media_application_id = '{{ sip_media_application_id }}' -- required
AND region = '{{ region }}' -- required
;

list_sip_media_applications

Lists the SIP media applications under the administrator's AWS account.

SELECT
aws_region,
created_timestamp,
endpoints,
name,
sip_media_application_arn,
sip_media_application_id,
updated_timestamp
FROM aws.chime_sdk_voice.sip_media_applications
WHERE region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_sip_media_application_call

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

INSERT INTO aws.chime_sdk_voice.sip_media_applications (
FromPhoneNumber,
ToPhoneNumber,
SipHeaders,
ArgumentsMap,
sip_media_application_id,
region
)
SELECT 
'{{ FromPhoneNumber }}' /* required */,
'{{ ToPhoneNumber }}' /* required */,
'{{ SipHeaders }}',
'{{ ArgumentsMap }}',
'{{ sip_media_application_id }}',
'{{ region }}'
RETURNING
sip_media_application_call
;

create_sip_media_application

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

INSERT INTO aws.chime_sdk_voice.sip_media_applications (
AwsRegion,
Name,
Endpoints,
Tags,
region
)
SELECT 
'{{ AwsRegion }}' /* required */,
'{{ Name }}',
'{{ Endpoints }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
sip_media_application
;

Manifest

# Description fields are for documentation purposes
- name: sip_media_applications
props:
  - name: sip_media_application_id
    value: "{{ sip_media_application_id }}"
    description: Required parameter for the sip_media_applications resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sip_media_applications resource.
  - name: FromPhoneNumber
    value: "{{ FromPhoneNumber }}"
  - name: ToPhoneNumber
    value: "{{ ToPhoneNumber }}"
  - name: SipHeaders
    value: "{{ SipHeaders }}"
  - name: ArgumentsMap
    value: "{{ ArgumentsMap }}"
  - name: AwsRegion
    value: "{{ AwsRegion }}"
  - name: Name
    value: "{{ Name }}"
  - name: Endpoints
    value:
      - LambdaArn: "{{ LambdaArn }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_sip_media_application_call

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

UPDATE aws.chime_sdk_voice.sip_media_applications
SET 
Arguments = '{{ Arguments }}'
WHERE 
sip_media_application_id = '{{ sip_media_application_id }}' --required
AND transaction_id = '{{ transaction_id }}' --required
AND region = '{{ region }}' --required
AND Arguments = '{{ Arguments }}' --required
RETURNING
sip_media_application_call;

update_sip_media_application

Updates the details of the specified SIP media application.

UPDATE aws.chime_sdk_voice.sip_media_applications
SET 
Name = '{{ Name }}',
Endpoints = '{{ Endpoints }}'
WHERE 
sip_media_application_id = '{{ sip_media_application_id }}' --required
AND region = '{{ region }}' --required
RETURNING
sip_media_application;

DELETE examples

delete_sip_media_application

Deletes a SIP media application.

DELETE FROM aws.chime_sdk_voice.sip_media_applications
WHERE sip_media_application_id = '{{ sip_media_application_id }}' --required
AND region = '{{ region }}' --required
;