AWS Service

This page describes operations you can perform on aws_services. List, and get details for.

List Aws Service

List all visible aws_services.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/aws_services

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
description query string - - Description of the AWS Service resource no
id query string hyph-uuid - Unique ID of the AWS Service resource no
name query string - - Name of the AWS Service resource no
zone query string - - Name of zone no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
aws_services array<object> AWS Service -
description string - Description of the AWS Service resource
id string hyph-uuid Unique ID of the AWS Service resource
name string - Name of the AWS Service resource
zone string - Name of zone

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "aws_services": [
    {
      "description": "AWS connectivity provider",
      "id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
      "name": "AWS-Service-Provider-01",
      "zone": "Lab3"
    },
    {
      "description": "AWS connectivity provider",
      "id": "63094f0a-81ee-4d7f-9b05-05c6a95aa8f2",
      "name": "AWS-Service-Provider-02",
      "zone": "Lab3"
    }
  ]
}

Show Aws Service

Show details for aws_service.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/aws_services/{aws_service_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
aws_service_id URI string hyph-uuid - Unique ID of the AWS Service resource yes

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
aws_service object AWS Service -
description string - Description of the AWS Service resource
id string hyph-uuid Unique ID of the AWS Service resource
name string - Name of the AWS Service resource
zone string - Name of zone

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "aws_service": {
    "description": "AWS connectivity provider",
    "id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "name": "AWS-Service-Provider-01",
    "zone": "Lab3"
  }
}