describe_tags ( $opt )

Lists the Auto Scaling group tags.

You can use filters to limit results when describing tags. For example, you can query for tags of a particular Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all your filters. If there’s no match, no special message is returned.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • Filters - array - Optional - The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).
    • x - array - Optional - This represents a simple array index.
      • Name - string - Optional - The name of the filter. Valid Name values are: "auto-scaling-group", "key", "value", and "propagate-at-launch". [Constraints: The value must match the following regular expression pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*]
      • Values - string|array - Optional - The value of the filter. Pass a string for a single value, or an indexed array for multiple values.
  • NextToken - string - Optional - A string that marks the start of the next batch of returned results. [Constraints: The value must match the following regular expression pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*]
  • MaxRecords - integer - Optional - The maximum number of records to return.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Source

Method defined in services/as.class.php | Toggle source view (15 lines) | View on GitHub

public function describe_tags($opt = null)
{
    if (!$opt) $opt = array();
            
    // Optional list + map
    if (isset($opt['Filters']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'Filters' => $opt['Filters']
        ), 'member'));
        unset($opt['Filters']);
    }

    return $this->authenticate('DescribeTags', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback