GET

/#Action=DescribeIpamScopes

http://ec2.{region}.amazonaws.com/#Action=DescribeIpamScopes

Get information about your IPAM scopes.

Access Token Required: API Key

Query Params

DryRunboolean

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Filterarray

One or more filters for the request. For more information about filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Filtering CLI output</a>.

MaxResultsinteger

The maximum number of results to return in the request.

NextTokenstring

The token for the next page of results.

IpamScopeIdarray

The IDs of the scopes you want information on.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=DescribeIpamScopes' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}