このページは日本語には対応しておりません。随時翻訳に取り組んでいます。
翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

aws_location_api_key

account_id

Type: STRING

create_time

Type: TIMESTAMP
Provider name: CreateTime
Description: The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

description

Type: STRING
Provider name: Description
Description: The optional description for the API key resource.

expire_time

Type: TIMESTAMP
Provider name: ExpireTime
Description: The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

key

Type: STRING
Provider name: Key
Description: The key value/string of an API key.

key_arn

Type: STRING
Provider name: KeyArn
Description: The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.

  • Format example: arn:aws:geo:region:account-id:key/ExampleKey

key_name

Type: STRING
Provider name: KeyName
Description: The name of the API key resource.

restrictions

Type: STRUCT
Provider name: Restrictions

  • allow_actions
    Type: UNORDERED_LIST_STRING
    Provider name: AllowActions
    Description: A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action. The following are valid values for the actions.
    • Map actions
      • geo:GetMap* - Allows all actions needed for map rendering.
      • geo-maps:GetTile - Allows retrieving map tiles.
      • geo-maps:GetStaticMap - Allows retrieving static map images.
      • geo-maps: - Allows all actions related to map functionalities.
    • Place actions
      • geo:SearchPlaceIndexForText - Allows geocoding.
      • geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
      • geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
      • GetPlace - Allows finding a place by place ID.
      • geo-places:Geocode - Allows geocoding using place information.
      • geo-places:ReverseGeocode - Allows reverse geocoding from location coordinates.
      • geo-places:SearchNearby - Allows searching for places near a location.
      • geo-places:SearchText - Allows searching for places based on text input.
      • geo-places:Autocomplete - Allows auto-completion of place names based on text input.
      • geo-places:Suggest - Allows generating suggestions for places based on partial input.
      • geo-places:GetPlace - Allows finding a place by its ID.
      • geo-places: - Allows all actions related to place services.
    • Route actions
      • geo:CalculateRoute - Allows point to point routing.
      • geo:CalculateRouteMatrix - Allows calculating a matrix of routes.
      • geo-routes:CalculateRoutes - Allows calculating multiple routes between points.
      • geo-routes:CalculateRouteMatrix - Allows calculating a matrix of routes between points.
      • geo-routes:CalculateIsolines - Allows calculating isolines for a given area.
      • geo-routes:OptimizeWaypoints - Allows optimizing the order of waypoints in a route.
      • geo-routes:SnapToRoads - Allows snapping a route to the nearest roads.
      • geo-routes: - Allows all actions related to routing functionalities.
    You must use these strings exactly. For example, to provide access to map rendering, the only valid action is geo:GetMap as an input to the list. [“geo:GetMap*”] is valid but [“geo:GetMapTile”] is not. Similarly, you cannot use [“geo:SearchPlaceIndexFor*”] - you must list each of the Place actions separately.
  • allow_android_apps
    Type: UNORDERED_LIST_STRUCT
    Provider name: AllowAndroidApps
    Description: An optional list of allowed Android applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
    • certificate_fingerprint
      Type: STRING
      Provider name: CertificateFingerprint
      Description: 20 byte SHA-1 certificate fingerprint associated with the Android app signing certificate. Example: BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • package
      Type: STRING
      Provider name: Package
      Description: Unique package name identifier for an Android app. Example: com.mydomain.appname
  • allow_apple_apps
    Type: UNORDERED_LIST_STRUCT
    Provider name: AllowAppleApps
    Description: An optional list of allowed Apple applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
    • bundle_id
      Type: STRING
      Provider name: BundleId
      Description: The unique identifier of the app across all Apple platforms (iOS, macOS, tvOS and watchOS). Example: com.mydomain.appname
  • allow_referers
    Type: UNORDERED_LIST_STRING
    Provider name: AllowReferers
    Description: An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed. Requirements:
    • Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $-._+!`(),;/?:@=&
    • May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
    • May contain wildcard characters question mark (?) and asterisk (). Question mark (?) will replace any single character (including hexadecimal digits). Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
    • No spaces allowed. For example, https://example.com.
  • allow_resources
    Type: UNORDERED_LIST_STRING
    Provider name: AllowResources
    Description: A list of allowed resource ARNs that a API key bearer can perform actions on.
    • The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
    • The resources must be in the same partition, region, and account-id as the key that is being created.
    • Other than wildcards, you must include the full ARN, including the arn, partition, service, region, account-id and resource-id delimited by colons (:).
    • No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
    For more information about ARN format, see Amazon Resource Names (ARNs).

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: UpdateTime
Description: The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.