api_client_setup_flashcards

(30 cards)

1
Q

What is an API endpoint?

A

The URL where you send API requests. It’s specific to the AWS service and Region. Format: servicename.region.amazonaws.com (Example: connect.us-east-1.amazonaws.com)

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
2
Q

What is AWS Signature Version 4 (SigV4)?

A

The authentication method required for Amazon Connect APIs. It uses IAM credentials to cryptographically sign API requests to prove identity.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
3
Q

What are the 4 required parameters for Amazon Connect API authentication?

A

Access Key ID | Secret Access Key | AWS Region (e.g. us-east-1) | Service Name (e.g. connect or profile)

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
4
Q

What is an Access Key ID?

A

Part 1 of IAM user credentials. Format: AKIAIOSFODNN7EXAMPLE. Used with secret access key to authenticate API requests.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
5
Q

What is a Secret Access Key?

A

Part 2 of IAM user credentials. Format: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY. Must be kept secure and used with access key ID.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
6
Q

What is a Session Token in API authentication?

A

Temporary credential used when assuming an IAM role. Provides same permissions as long-term credentials but expires after a set time.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
7
Q

What is a Postman Collection?

A

A container that organizes related API requests and shares configuration (like authentication) across all requests within it.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
8
Q

What are the 3 components of an Amazon Connect API URI?

A

Resource type (/users /queues /contacts) | Instance ID | Resource ID (for specific resource operations)

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
9
Q

What does the PUT HTTP method do?

A

Creates a new resource OR updates an existing resource. Always requires a request body with complete resource data.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
10
Q

What does the DELETE HTTP method do?

A

Removes/deletes a resource. Only requires the URI - no request body needed.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
11
Q

What does the GET HTTP method do?

A

Retrieves information about a resource. Returns data about the specified resource without modifying it.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
12
Q

What does the POST HTTP method do?

A

Creates a new resource or submits data for processing. Requires a request body with the data being sent.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
13
Q

What does a 200 HTTP status code mean?

A

Success - the request was completed successfully. Resource was created | updated | retrieved | or deleted as requested.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
14
Q

What is a Request Body (or Request Model)?

A

JSON data sent with PUT or POST requests that contains the information needed to create or update a resource.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
15
Q

What is a Response Body (or Response Model)?

A

JSON data returned by the API after processing a request. Contains result data like created resource IDs or error messages.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
16
Q

What is the AWS SDK?

A

Software Development Kit - libraries (boto3 for Python | aws-sdk for Node.js) that simplify making authenticated API calls to AWS services.

17
Q

Step 1: Setting up Postman - What do you create first?

A

Create a new Collection to organize your Amazon Connect API requests.

18
Q

Step 2: Setting up Postman - Where do you configure authentication?

A

Configure authentication at the Collection level so all requests in that collection inherit the auth settings.

19
Q

Step 3: Setting up Postman - What auth type do you select?

A

Select AWS Signature as the authorization type for Amazon Connect APIs.

20
Q

Step 4: Setting up Postman - What 4 values do you enter for auth?

A

Access Key ID | Secret Access Key | AWS Region | Service Name (connect)

21
Q

Step 5: Setting up Postman - How do you build the request URL?

A

Combine endpoint (connect.region.amazonaws.com) + path (/users/instance-id or /queues/instance-id/queue-id)

22
Q

Step 6: Setting up Postman - What do you select for the HTTP method?

A

Choose the method based on operation: GET (retrieve) | PUT (create/update) | POST (create/submit) | DELETE (remove)

23
Q

Step 7: Setting up Postman - When do you need a request body?

A

PUT and POST methods require a request body. GET and DELETE do not.

24
Q

Step 8: Setting up Postman - What do you check after sending a request?

A

Check the status code (200 = success) and examine the response body for returned data or error messages.

25
What are the 3 testing scenarios you should verify in Postman?
Successful creation (PUT with body expect 200) | Successful retrieval (GET expect 200 + data) | Successful deletion (DELETE expect 200)
26
After Postman testing succeeds what is the automation approach?
Write Lambda function code using AWS SDK (boto3/aws-sdk) that makes the same API calls Postman successfully made.
27
How does Lambda authenticate to Amazon Connect APIs?
Lambda uses IAM role permissions. If the Lambda execution role has Connect permissions then boto3/aws-sdk handles authentication automatically.
28
What is the Lambda automation flow for API integration?
Lambda triggered by event | Lambda receives input data | Lambda uses SDK to call Connect API | API processes and responds | Lambda returns result
29
Why test in Postman before writing Lambda code?
Validates endpoint URLs are correct | authentication works | request body format is proper | expected responses are understood. Reduces debugging in code.
30
What IAM permissions does the API user need?
The IAM user (for Postman) or IAM role (for Lambda) must have permissions for the specific Amazon Connect operations being performed (e.g. CreateUser DeleteUser).