Cách tạo Cổng API trong Python

Amazon API Gateway giúp các nhà phát triển cung cấp phần cuối của ứng dụng web và di động mạnh mẽ, an toàn và có thể mở rộng. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS

import boto3

client = boto3.client['apigateway']

These are the available methods

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    72
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    73
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    74
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    75
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    76
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    77
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    78
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    79
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    80
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    81
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    82
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    83
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    84
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    85
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    86
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    87
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    88
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    89
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    90
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    91
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    92
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    93
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    94
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    95
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    96
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    97
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    98
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    99
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    900
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    901
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    902
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    903
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    904
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    905
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    906
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    907
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    908
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    914
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    915
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    916
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    917
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    918
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    919
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    920
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    921
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    922
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    923
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    924
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    925
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    926
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    927
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    928
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    929
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    930
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    931
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    932
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    933
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    934
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    935
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    936
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    937
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    938
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    939
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    940
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    941
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    942
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    943
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    944
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    945
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    946
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    947
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    948
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    949
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    950
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    951
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    952
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    953
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    954
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    955
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    956
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    957
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    958
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    959
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    960
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    961
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    962
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    963
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    964
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    965
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    966
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    967
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    968
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    969
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    970
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    971
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    972
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    973
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    974
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    975
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    976
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    977
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    978
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    979
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    980
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    981
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    982
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    983
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    984
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    985
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    986
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    987
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    988
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    989
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    990
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    991
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    992
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    993
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    994
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    995
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
996 [ operation_name ]

Kiểm tra xem một hoạt động có thể được phân trang

Tham số tên_hoạt động [chuỗi] -- Tên hoạt động. Đây là tên giống như tên phương thức trên máy khách. Ví dụ: nếu tên phương thức là
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
997 và bạn thường gọi thao tác là
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
998, nếu thao tác
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
997 có thể được phân trang, bạn có thể sử dụng lệnh gọi
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2900. Trả về
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2901 nếu thao tác có thể được phân trang, ngược lại là
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2902.
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2903 []

Đóng các kết nối điểm cuối cơ bản

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2904 [ **kwargs ]

Tạo tài nguyên ApiKey

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
34

Thông số
  • name [string] -- Tên của ApiKey
  • description [string] -- Mô tả về ApiKey
  • đã bật [boolean] -- Chỉ định xem người gọi có thể sử dụng ApiKey hay không
  • generateDistinctId [boolean] -- Chỉ định [
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2905 ] hay không [
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2906 ] mã định danh khóa khác với giá trị khóa API đã tạo. Tham số này không được dùng nữa và không nên được sử dụng
  • giá trị [chuỗi] - Chỉ định giá trị của khóa API
  • stageKeys [danh sách] --

    KHÔNG DÙNG CHO KẾ HOẠCH SỬ DỤNG - Chỉ định các giai đoạn được liên kết với khóa API

    • [chính tả] --

      Tham chiếu đến một giai đoạn duy nhất được xác định ở định dạng

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2907

      • restApiId [chuỗi] --

        Mã định danh chuỗi của RestApi được liên kết

      • tên sân khấu [chuỗi] --

        Tên sân khấu được liên kết với khóa sân khấu

  • customerId [string] -- Mã định danh khách hàng AWS Marketplace , khi tích hợp với AWS SaaS Marketplace
  • thẻ [dict] --

    Bản đồ khóa-giá trị của chuỗi. Bộ ký tự hợp lệ là [a-zA-Z+-=. _. /]. Khóa thẻ có thể dài tối đa 128 ký tự và không được bắt đầu bằng

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2908. Giá trị thẻ có thể lên tới 256 ký tự

    • [chuỗi] --
      • [chuỗi] --
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}

Cấu trúc phản hồi

  • [chính tả] --

    Một tài nguyên có thể được phân phối cho người gọi để thực thi các tài nguyên Phương thức yêu cầu khóa API. Các khóa API có thể được ánh xạ tới bất kỳ Giai đoạn nào trên bất kỳ RestApi nào, điều này cho biết rằng những người gọi có khóa API có thể thực hiện các yêu cầu đối với giai đoạn đó

    • id [chuỗi] --

      Mã định danh của Khóa API

    • giá trị [chuỗi] --

      Giá trị của Khóa API

    • tên [chuỗi] --

      Tên của Khóa API

    • ID khách hàng [chuỗi] --

      Mã định danh khách hàng AWS Marketplace , khi tích hợp với AWS SaaS Marketplace

    • mô tả [chuỗi] --

      Mô tả của Khóa API

    • đã bật [boolean] --

      Chỉ định liệu người gọi có thể sử dụng Khóa API hay không

    • ngày tạo [ngày giờ] --

      Dấu thời gian khi Khóa API được tạo

    • lastUpdatedDate [ngày giờ] --

      Dấu thời gian khi Khóa API được cập nhật lần cuối

    • stageKeys [danh sách] --

      Danh sách các tài nguyên Giai đoạn được liên kết với tài nguyên ApiKey

      • [chuỗi] --
    • thẻ [dict] --

      Bộ sưu tập các thẻ. Mỗi phần tử thẻ được liên kết với một tài nguyên nhất định

      • [chuỗi] --
        • [chuỗi] --

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2915 [ **kwargs ]

Thêm tài nguyên Trình ủy quyền mới vào tài nguyên RestApi hiện có

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
9

Thông số
  • restApiId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh chuỗi của RestApi được liên kết

  • tên [chuỗi] --

    [CẦN THIẾT]

    Tên người ủy quyền

  • loại [chuỗi] --

    [CẦN THIẾT]

    Loại ủy quyền. Các giá trị hợp lệ là

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2916 đối với hàm Lambda sử dụng một mã thông báo ủy quyền duy nhất được gửi trong tiêu đề tùy chỉnh,
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2917 đối với hàm Lambda sử dụng tham số yêu cầu gửi đến và
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2918 đối với việc sử dụng nhóm người dùng Amazon Cognito

  • nhà cung cấpARN [danh sách] --

    Danh sách ARN nhóm người dùng Amazon Cognito cho người ủy quyền

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2918. Mỗi phần tử có định dạng này.
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2920. Đối với người ủy quyền
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2916 hoặc
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2917, điều này không được xác định

    • [chuỗi] --
  • authType [string] -- Trường tùy chọn do khách hàng xác định, được sử dụng trong nhập và xuất OpenAPI mà không ảnh hưởng đến chức năng
  • ủy quyềnUri [chuỗi] - Chỉ định Mã định danh tài nguyên thống nhất [URI] của người ủy quyền. Đối với người ủy quyền
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2916 hoặc
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2917, đây phải là một URI hàm Lambda được định dạng tốt, ví dụ:
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2925. Nói chung, URI có dạng này
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2926 , trong đó
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2927 giống với khu vực lưu trữ hàm Lambda,
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2928 chỉ ra rằng chuỗi con còn lại trong URI phải được coi là đường dẫn đến tài nguyên, bao gồm cả ký tự đầu tiên
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2929. Đối với các hàm Lambda, hàm này thường có dạng
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2930
  • ủy quyềnCredentials [chuỗi] - Chỉ định thông tin đăng nhập cần thiết dưới dạng vai trò IAM cho Cổng API để gọi trình ủy quyền. Để chỉ định một vai trò IAM cho API Gateway đảm nhận, hãy sử dụng Tên tài nguyên Amazon [ARN] của vai trò đó. Để sử dụng các quyền dựa trên tài nguyên trên hàm Lambda, hãy chỉ định null
  • IdentitySource [string] -- Nguồn nhận dạng được yêu cầu ủy quyền. Đối với người ủy quyền
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2916 hoặc
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2918, điều này là bắt buộc và chỉ định biểu thức ánh xạ tiêu đề yêu cầu cho tiêu đề tùy chỉnh chứa mã thông báo ủy quyền do khách hàng gửi. Ví dụ: nếu tên tiêu đề mã thông báo là
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2933 thì biểu thức ánh xạ tiêu đề là
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2934. Đối với trình ủy quyền
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2917, điều này là bắt buộc khi bộ nhớ đệm ủy quyền được bật. Giá trị là một chuỗi được phân tách bằng dấu phẩy gồm một hoặc nhiều biểu thức ánh xạ của các tham số yêu cầu đã chỉ định. Ví dụ: nếu tiêu đề
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2933, tham số chuỗi truy vấn
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2937 được xác định là nguồn nhận dạng, thì giá trị này là
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2938. Các tham số này sẽ được sử dụng để lấy khóa bộ đệm ẩn ủy quyền và để thực hiện xác thực thời gian chạy của trình ủy quyền
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2917 bằng cách xác minh tất cả các tham số yêu cầu liên quan đến danh tính đều có mặt, không rỗng và không trống. Chỉ khi điều này đúng thì trình ủy quyền mới gọi hàm Lambda của trình ủy quyền, nếu không, nó trả về phản hồi 401 Trái phép mà không gọi hàm Lambda. Giá trị hợp lệ là một chuỗi các biểu thức ánh xạ được phân tách bằng dấu phẩy của các tham số yêu cầu đã chỉ định. Khi bộ đệm ẩn ủy quyền không được bật, thuộc tính này là tùy chọn
  • IDValidationExpression [chuỗi] - Biểu thức xác thực cho mã thông báo nhận dạng đến. Đối với người ủy quyền
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2916, giá trị này là một biểu thức chính quy. Đối với người ủy quyền
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2918, API Gateway sẽ khớp trường
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2942 của mã thông báo đến từ ứng dụng khách với biểu thức chính quy đã chỉ định. Nó sẽ gọi hàm Lambda của người ủy quyền khi có kết quả khớp. Nếu không, nó sẽ trả về phản hồi 401 Trái phép mà không gọi hàm Lambda. The validation expression does not apply to the
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2917 authorizer
  • authorizerResultTtlInSeconds [integer] -- The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. Nếu nó lớn hơn 0, API Gateway sẽ lưu vào bộ đệm các phản hồi của người ủy quyền. Nếu trường này không được đặt, giá trị mặc định là 300. Giá trị tối đa là 3600 hoặc 1 giờ
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
29

Cấu trúc phản hồi

  • [chính tả] --

    Đại diện cho một lớp ủy quyền cho các phương pháp. Nếu được bật trên một phương thức, API Gateway sẽ kích hoạt trình ủy quyền khi khách hàng gọi phương thức đó

    • id [chuỗi] --

      Mã định danh cho tài nguyên ủy quyền

    • tên [chuỗi] --

      Tên người ủy quyền

    • loại [chuỗi] --

      Loại ủy quyền. Các giá trị hợp lệ là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2916 đối với hàm Lambda sử dụng một mã thông báo ủy quyền duy nhất được gửi trong tiêu đề tùy chỉnh,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2917 đối với hàm Lambda sử dụng tham số yêu cầu gửi đến và
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2918 đối với việc sử dụng nhóm người dùng Amazon Cognito

    • nhà cung cấpARN [danh sách] --

      Danh sách ARN nhóm người dùng Amazon Cognito cho người ủy quyền

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2918. Mỗi phần tử có định dạng này.
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2920. Đối với người ủy quyền
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2916 hoặc
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2917, điều này không được xác định

      • [chuỗi] --
    • authType [chuỗi] --

      Trường tùy chọn do khách hàng xác định, được sử dụng trong nhập và xuất OpenAPI mà không ảnh hưởng đến chức năng

    • ủy quyềnUri [chuỗi] --

      Chỉ định Mã định danh tài nguyên thống nhất [URI] của người ủy quyền. Đối với người ủy quyền

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2916 hoặc
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2917, đây phải là một URI hàm Lambda được định dạng tốt, ví dụ:
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2925. Nói chung, URI có dạng này
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2926 , trong đó
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2927 giống với khu vực lưu trữ hàm Lambda,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2928 cho biết chuỗi con còn lại trong URI phải được coi là đường dẫn đến tài nguyên, bao gồm cả ký tự đầu tiên
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2929. Đối với các hàm Lambda, hàm này thường có dạng
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2930

    • ủy quyềnCredentials [chuỗi] --

      Chỉ định thông tin đăng nhập cần thiết dưới dạng vai trò IAM cho Cổng API để gọi trình ủy quyền. Để chỉ định một vai trò IAM cho API Gateway đảm nhận, hãy sử dụng Tên tài nguyên Amazon [ARN] của vai trò đó. Để sử dụng các quyền dựa trên tài nguyên trên hàm Lambda, hãy chỉ định null

    • danh tínhSource [chuỗi] --

      Nguồn nhận dạng được yêu cầu ủy quyền. Đối với người ủy quyền

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2916 hoặc
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2918, điều này là bắt buộc và chỉ định biểu thức ánh xạ tiêu đề yêu cầu cho tiêu đề tùy chỉnh chứa mã thông báo ủy quyền do khách hàng gửi. Ví dụ: nếu tên tiêu đề mã thông báo là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2933 thì biểu thức ánh xạ tiêu đề là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2934. Đối với trình ủy quyền
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2917, điều này là bắt buộc khi bộ nhớ đệm ủy quyền được bật. Giá trị là một chuỗi được phân tách bằng dấu phẩy gồm một hoặc nhiều biểu thức ánh xạ của các tham số yêu cầu đã chỉ định. Ví dụ: nếu tiêu đề
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2933, tham số chuỗi truy vấn
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2937 được xác định là nguồn nhận dạng, thì giá trị này là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2934 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2967. Các tham số này sẽ được sử dụng để lấy khóa bộ đệm ẩn ủy quyền và để thực hiện xác thực thời gian chạy của trình ủy quyền
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2917 bằng cách xác minh tất cả các tham số yêu cầu liên quan đến danh tính đều có mặt, không rỗng và không trống. Chỉ khi điều này đúng thì trình ủy quyền mới gọi hàm Lambda của trình ủy quyền, nếu không, nó trả về phản hồi 401 Trái phép mà không gọi hàm Lambda. Giá trị hợp lệ là một chuỗi các biểu thức ánh xạ được phân tách bằng dấu phẩy của các tham số yêu cầu đã chỉ định. Khi bộ đệm ẩn ủy quyền không được bật, thuộc tính này là tùy chọn

    • IDValidationExpression [chuỗi] --

      Biểu thức xác thực cho mã thông báo nhận dạng đến. Đối với người ủy quyền

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2916, giá trị này là một biểu thức chính quy. Đối với người ủy quyền
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2918, API Gateway sẽ khớp trường
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2942 của mã thông báo đến từ ứng dụng khách với biểu thức chính quy đã chỉ định. Nó sẽ gọi hàm Lambda của người ủy quyền khi có kết quả khớp. Nếu không, nó sẽ trả về phản hồi 401 Trái phép mà không gọi hàm Lambda. Biểu thức xác thực không áp dụng cho người ủy quyền
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2917

    • ủy quyềnResultTtlInSeconds [số nguyên] --

      TTL tính bằng giây của kết quả trình ủy quyền được lưu trong bộ nhớ cache. Nếu nó bằng 0, bộ nhớ đệm ủy quyền bị tắt. Nếu nó lớn hơn 0, API Gateway sẽ lưu vào bộ đệm các phản hồi của người ủy quyền. Nếu trường này không được đặt, giá trị mặc định là 300. Giá trị tối đa là 3600 hoặc 1 giờ

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2979 [ **kwargs ]

Tạo một tài nguyên BasePathMapping mới

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
13

Thông số
  • domainName [string] --

    [CẦN THIẾT]

    Tên miền của tài nguyên BasePathMapping để tạo

  • basePath [string] -- Tên đường dẫn cơ sở mà người gọi API phải cung cấp như một phần của URL sau tên miền. Giá trị này phải là duy nhất cho tất cả các ánh xạ trên một API duy nhất. Chỉ định '[none]' nếu bạn không muốn người gọi chỉ định tên đường dẫn cơ sở sau tên miền
  • restApiId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh chuỗi của RestApi được liên kết

  • giai đoạn [chuỗi] - Tên của giai đoạn API mà bạn muốn sử dụng cho ánh xạ này. Chỉ định '[none]' nếu bạn muốn người gọi chỉ định rõ ràng nghệ danh sau bất kỳ tên đường dẫn cơ sở nào
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
14

Cấu trúc phản hồi

  • [chính tả] --

    Đại diện cho đường dẫn cơ sở mà người gọi API phải cung cấp như một phần của URL sau tên miền

    • đường dẫn cơ sở [chuỗi] --

      Tên đường dẫn cơ sở mà người gọi API phải cung cấp như một phần của URL sau tên miền

    • restApiId [chuỗi] --

      Mã định danh chuỗi của RestApi được liên kết

    • sân khấu [chuỗi] --

      Tên của giai đoạn liên quan

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2986 [ **kwargs ]

Tạo tài nguyên Triển khai, làm cho RestApi được chỉ định có thể gọi được qua internet

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
22

Thông số
  • restApiId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh chuỗi của RestApi được liên kết

  • stageName [string] -- Tên của Stage resource cho Deployment resource để tạo
  • stageDescription [string] -- Mô tả về Stage resource cho Deployment resource để tạo
  • mô tả [chuỗi] -- Mô tả cho tài nguyên Triển khai để tạo
  • cacheClusterEnabled [boolean] - Bật cụm bộ đệm cho tài nguyên Giai đoạn được chỉ định trong đầu vào
  • cacheClusterSize [string] -- Chỉ định kích thước cụm bộ đệm cho tài nguyên Giai đoạn được chỉ định trong đầu vào, nếu cụm bộ đệm được bật
  • biến [dict] --

    Bản đồ xác định các biến giai đoạn cho tài nguyên Giai đoạn được liên kết với triển khai mới. Tên biến có thể có ký tự chữ và số và dấu gạch dưới và các giá trị phải khớp với

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2987

    • [chuỗi] --
      • [chuỗi] --
  • canarySettings [dict] --

    Cấu hình đầu vào cho triển khai canary khi triển khai là triển khai phát hành canary

    • phần trămTraffic [thả nổi] --

      Tỷ lệ phần trăm [0. 0-100. 0] lưu lượng truy cập được định tuyến đến triển khai canary

    • stageVariableOverrides [dict] --

      Ghi đè biến giai đoạn được sử dụng để triển khai bản phát hành canary. Họ có thể ghi đè các biến giai đoạn hiện có hoặc thêm các biến giai đoạn mới để triển khai bản phát hành hoàng yến. Các biến giai đoạn này được biểu diễn dưới dạng ánh xạ chuỗi thành chuỗi giữa tên biến giai đoạn và giá trị của chúng

      • [chuỗi] --
        • [chuỗi] --
    • useStageCache [boolean] --

      Một cờ Boolean để cho biết liệu việc triển khai bản phát hành canary có sử dụng bộ đệm giai đoạn hay không

  • tracingEnabled [boolean] -- Chỉ định xem có bật chức năng theo dõi chủ động bằng tia X cho Giai đoạn hay không
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
24

Cấu trúc phản hồi

  • [chính tả] --

    Một đại diện bất biến của tài nguyên RestApi có thể được gọi bởi người dùng bằng cách sử dụng Giai đoạn. Việc triển khai phải được liên kết với Giai đoạn để có thể gọi được qua Internet

    • id [chuỗi] --

      Mã định danh cho tài nguyên triển khai

    • mô tả [chuỗi] --

      Mô tả cho tài nguyên triển khai

    • ngày tạo [ngày giờ] --

      Ngày và giờ mà tài nguyên triển khai được tạo

    • apiSummary [dict] --

      A summary of the RestApi at the date and time that the deployment resource was created

      • [chuỗi] --

        • [chính tả] --

          • [chuỗi] --

            • [chính tả] --

              Represents a summary of a Method resource, given a particular date and time

              • loại ủy quyền [chuỗi] --

                Loại ủy quyền của phương thức. Các giá trị hợp lệ là

                {
                    'id': 'string',
                    'value': 'string',
                    'name': 'string',
                    'customerId': 'string',
                    'description': 'string',
                    'enabled': True|False,
                    'createdDate': datetime[2015, 1, 1],
                    'lastUpdatedDate': datetime[2015, 1, 1],
                    'stageKeys': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    }
                }
                
                2988 để truy cập mở,
                {
                    'id': 'string',
                    'value': 'string',
                    'name': 'string',
                    'customerId': 'string',
                    'description': 'string',
                    'enabled': True|False,
                    'createdDate': datetime[2015, 1, 1],
                    'lastUpdatedDate': datetime[2015, 1, 1],
                    'stageKeys': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    }
                }
                
                2989 để sử dụng quyền AWS IAM,
                {
                    'id': 'string',
                    'value': 'string',
                    'name': 'string',
                    'customerId': 'string',
                    'description': 'string',
                    'enabled': True|False,
                    'createdDate': datetime[2015, 1, 1],
                    'lastUpdatedDate': datetime[2015, 1, 1],
                    'stageKeys': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    }
                }
                
                2990 để sử dụng trình ủy quyền tùy chỉnh hoặc
                {
                    'id': 'string',
                    'value': 'string',
                    'name': 'string',
                    'customerId': 'string',
                    'description': 'string',
                    'enabled': True|False,
                    'createdDate': datetime[2015, 1, 1],
                    'lastUpdatedDate': datetime[2015, 1, 1],
                    'stageKeys': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    }
                }
                
                2918 để sử dụng nhóm người dùng Cognito

              • apiKeyRequired [boolean] --

                Chỉ định xem phương thức có yêu cầu ApiKey hợp lệ hay không

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2998
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2999 [ **kwargs ]

Tạo một phần tài liệu

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
37

Thông số
  • restApiId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh chuỗi của RestApi được liên kết

  • vị trí [dict] --

    [CẦN THIẾT]

    Vị trí của thực thể API được nhắm mục tiêu của phần tài liệu sắp được tạo

    • loại [chuỗi] -- [BẮT BUỘC]

      Loại thực thể API mà nội dung tài liệu áp dụng. Các giá trị hợp lệ là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1300 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1301 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1302 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1303 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1304 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1305 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1306 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1307 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1308 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1309 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1310 và
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1311. Content inheritance does not apply to any entity of the
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1300 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1301 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1304 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1302 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1308 , or
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1303 type

    • đường dẫn [chuỗi] --

      Đường dẫn URL của mục tiêu. Đây là trường hợp lệ cho các loại thực thể API là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1303 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1304 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1305 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1306 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1307 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1308 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1309 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1310 và
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1311. Giá trị mặc định là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2929 cho tài nguyên gốc. Khi một thực thể con thích hợp kế thừa nội dung của một thực thể khác cùng loại với các thông số kỹ thuật chung hơn của các thuộc tính
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1328 khác, thì thuộc tính
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2928 của thực thể con phải khớp với thuộc tính của thực thể mẹ làm tiền tố

    • phương thức [chuỗi] --

      Động từ HTTP của một phương thức. Đây là trường hợp lệ cho các loại thực thể API là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1304 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1305 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1306 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1307 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1308 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1309 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1310 và
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1311. Giá trị mặc định là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1338 cho bất kỳ phương thức nào. Khi một thực thể con thích hợp kế thừa nội dung của một thực thể cùng loại với các thông số chung hơn của các thuộc tính
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1328 khác, thì thuộc tính
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1340 của thực thể con phải khớp chính xác với thuộc tính của thực thể mẹ

    • mã trạng thái [chuỗi] --

      Mã trạng thái HTTP của phản hồi. Đây là trường hợp lệ cho các loại thực thể API là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1309 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1310 và
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1311. Giá trị mặc định là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1338 cho bất kỳ mã trạng thái nào. Khi một thực thể con thích hợp kế thừa nội dung của một thực thể cùng loại với các thông số kỹ thuật chung hơn của các thuộc tính
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1328 khác, thì thuộc tính
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1346 của thực thể con phải khớp chính xác với thuộc tính của thực thể mẹ

    • tên [chuỗi] --

      Tên của thực thể API được nhắm mục tiêu. Đây là trường hợp lệ và bắt buộc đối với các loại thực thể API là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1301 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1302 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1305 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1306 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1307 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1308 và
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1310. Đây là trường không hợp lệ cho bất kỳ loại thực thể nào khác

  • thuộc tính [chuỗi] --

    [CẦN THIẾT]

    Bản đồ nội dung tài liệu mới của thực thể API được nhắm mục tiêu. Các cặp khóa-giá trị kèm theo dành riêng cho API, nhưng chỉ các cặp khóa-giá trị tuân thủ OpenAPI mới có thể được xuất và do đó, được xuất bản

loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
340

Cấu trúc phản hồi

  • [chính tả] --

    Một phần tài liệu cho một thực thể API được nhắm mục tiêu

    • id [chuỗi] --

      Mã định danh DocumentationPart, được tạo bởi API Gateway khi tạo

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1354

    • vị trí [dict] --

      Vị trí của thực thể API mà tài liệu áp dụng. Các trường hợp lệ phụ thuộc vào loại thực thể API được nhắm mục tiêu. Tất cả các trường vị trí hợp lệ là không bắt buộc. Nếu không được chỉ định rõ ràng, trường vị trí hợp lệ được coi là ký tự đại diện và nội dung tài liệu liên quan có thể được kế thừa bởi các thực thể phù hợp, trừ khi bị ghi đè

      • loại [chuỗi] --

        Loại thực thể API mà nội dung tài liệu áp dụng. Các giá trị hợp lệ là

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1300 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1301 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1302 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1303 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1304 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1305 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1306 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1307 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1308 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1309 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1310 và
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1311. Content inheritance does not apply to any entity of the
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1300 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1301 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1304 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1302 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1308 , or
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1303 type

      • đường dẫn [chuỗi] --

        Đường dẫn URL của mục tiêu. Đây là trường hợp lệ cho các loại thực thể API là

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1303 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1304 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1305 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1306 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1307 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1308 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1309 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1310 và
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1311. Giá trị mặc định là
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        2929 cho tài nguyên gốc. Khi một thực thể con thích hợp kế thừa nội dung của một thực thể khác cùng loại với các thông số kỹ thuật chung hơn của các thuộc tính
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1328 khác, thì thuộc tính
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        2928 của thực thể con phải khớp với thuộc tính của thực thể mẹ làm tiền tố

      • phương thức [chuỗi] --

        Động từ HTTP của một phương thức. Đây là trường hợp lệ cho các loại thực thể API là

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1304 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1305 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1306 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1307 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1308 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1309 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1310 và
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1311. Giá trị mặc định là
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1338 cho bất kỳ phương thức nào. Khi một thực thể con thích hợp kế thừa nội dung của một thực thể cùng loại với các thông số chung hơn của các thuộc tính
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1328 khác, thì thuộc tính
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1340 của thực thể con phải khớp chính xác với thuộc tính của thực thể mẹ

      • mã trạng thái [chuỗi] --

        Mã trạng thái HTTP của phản hồi. Đây là trường hợp lệ cho các loại thực thể API là

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1309 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1310 và
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1311. Giá trị mặc định là
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1338 cho bất kỳ mã trạng thái nào. Khi một thực thể con thích hợp kế thừa nội dung của một thực thể cùng loại với các thông số kỹ thuật chung hơn của các thuộc tính
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1328 khác, thì thuộc tính
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1346 của thực thể con phải khớp chính xác với thuộc tính của thực thể mẹ

      • tên [chuỗi] --

        Tên của thực thể API được nhắm mục tiêu. Đây là trường hợp lệ và bắt buộc đối với các loại thực thể API là

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1301 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1302 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1305 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1306 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1307 ,
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1308 và
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1310. Đây là trường không hợp lệ cho bất kỳ loại thực thể nào khác

    • thuộc tính [chuỗi] --

      Bản đồ nội dung của các cặp khóa-giá trị dành riêng cho API mô tả thực thể API được nhắm mục tiêu. Bản đồ phải được mã hóa dưới dạng chuỗi JSON, e. g. ,

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1409. Chỉ các trường liên quan đến tài liệu tuân thủ OpenAPI từ bản đồ thuộc tính mới được xuất và do đó, được xuất bản như một phần của định nghĩa thực thể API, trong khi các phần tài liệu gốc được xuất trong tiện ích mở rộng OpenAPI của
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1410

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
1417 [ **kwargs ]

Tạo một phiên bản tài liệu

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
341

Thông số
  • restApiId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh chuỗi của RestApi được liên kết

  • tài liệuVersion [chuỗi] --

    [CẦN THIẾT]

    Mã định danh phiên bản của ảnh chụp nhanh mới

  • stageName [string] -- Tên sân khấu được liên kết với ảnh chụp nhanh tài liệu mới
  • mô tả [chuỗi] - Mô tả về ảnh chụp nhanh tài liệu mới
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
342

Cấu trúc phản hồi

  • [chính tả] --

    Ảnh chụp nhanh tài liệu của API

    • phiên bản [chuỗi] --

      Mã định danh phiên bản của ảnh chụp nhanh tài liệu API

    • ngày tạo [ngày giờ] --

      Ngày tạo ảnh chụp nhanh tài liệu API

    • mô tả [chuỗi] --

      Mô tả về ảnh chụp nhanh tài liệu API

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
1424 [ **kwargs ]

Tạo một tên miền mới

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
343

Thông số
  • domainName [string] --

    [CẦN THIẾT]

    Tên của tài nguyên DomainName

  • certificateName [string] -- Tên thân thiện với người dùng của chứng chỉ sẽ được sử dụng bởi điểm cuối được tối ưu hóa cạnh cho tên miền này
  • certificateBody [string] -- [Không dùng nữa] Phần thân của chứng chỉ máy chủ sẽ được sử dụng bởi điểm cuối được tối ưu hóa cạnh cho tên miền này do tổ chức phát hành chứng chỉ của bạn cung cấp
  • certificatePrivateKey [string] -- [Không dùng nữa] Khóa riêng của chứng chỉ tên miền của điểm cuối được tối ưu hóa cạnh của bạn
  • certificateChain [chuỗi] -- [Không dùng nữa] Chứng chỉ trung gian và chứng chỉ gốc tùy chọn, lần lượt từng chứng chỉ mà không có bất kỳ dòng trống nào, được sử dụng bởi điểm cuối được tối ưu hóa cạnh cho tên miền này. Nếu bạn bao gồm chứng chỉ gốc, thì chuỗi chứng chỉ của bạn phải bắt đầu bằng chứng chỉ trung gian và kết thúc bằng chứng chỉ gốc. Sử dụng các chứng chỉ trung gian do cơ quan cấp chứng chỉ của bạn cung cấp. Không bao gồm bất kỳ bên trung gian nào không nằm trong chuỗi đường dẫn tin cậy
  • certificateArn [chuỗi] -- Tham chiếu đến chứng chỉ do AWS quản lý sẽ được sử dụng bởi điểm cuối được tối ưu hóa cạnh cho tên miền này. AWS Certificate Manager là nguồn được hỗ trợ duy nhất
  • khu vựcCertificateName [chuỗi] - Tên thân thiện với người dùng của chứng chỉ sẽ được sử dụng bởi điểm cuối khu vực cho tên miền này
  • khu vựcCertificateArn [chuỗi] -- Tham chiếu đến chứng chỉ do AWS quản lý sẽ được điểm cuối khu vực sử dụng cho tên miền này. AWS Certificate Manager là nguồn được hỗ trợ duy nhất
  • endpointConfiguration [dict] --

    Cấu hình điểm cuối của Tên miền này hiển thị các loại điểm cuối của tên miền

    • loại [danh sách] --

      Danh sách các loại điểm cuối của API [RestApi] hoặc tên miền tùy chỉnh của nó [DomainName]. Đối với API được tối ưu hóa cạnh và tên miền tùy chỉnh của nó, loại điểm cuối là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1425. Đối với API khu vực và tên miền tùy chỉnh của nó, loại điểm cuối là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1426. Đối với API riêng tư, loại điểm cuối là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1427

      • [chuỗi] --

        Loại điểm cuối. Các giá trị hợp lệ là

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1428 để thiết lập API được tối ưu hóa cạnh, phù hợp nhất cho các ứng dụng dành cho thiết bị di động;

    • vpcEndpointIds [danh sách] --

      Danh sách các VpcEndpointId của một API [RestApi] để tạo các ALIAS của Route53. Nó chỉ được hỗ trợ cho loại điểm cuối

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1427

      • [chuỗi] --
  • thẻ [dict] --

    Bản đồ khóa-giá trị của chuỗi. Bộ ký tự hợp lệ là [a-zA-Z+-=. _. /]. Khóa thẻ có thể dài tối đa 128 ký tự và không được bắt đầu bằng

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2908. Giá trị thẻ có thể lên tới 256 ký tự

    • [chuỗi] --
      • [chuỗi] --
  • securityPolicy [string] -- The Transport Layer Security [TLS] version + cipher suite for this DomainName. Các giá trị hợp lệ là
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    1433 và
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    1434
  • lẫn nhauTlsAuthentication [dict] --

    Cấu hình xác thực TLS lẫn nhau cho một tên miền tùy chỉnh. Nếu được chỉ định, API Gateway sẽ thực hiện xác thực hai chiều giữa máy khách và máy chủ. Khách hàng phải xuất trình chứng chỉ đáng tin cậy để truy cập API của bạn

    • truststoreUri [chuỗi] --

      URL Amazon S3 chỉ định kho tin cậy để xác thực TLS lẫn nhau, ví dụ:

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1435. Cửa hàng ủy thác có thể chứa các chứng chỉ từ cơ quan cấp chứng chỉ công cộng hoặc tư nhân. Để cập nhật cửa hàng tin cậy, hãy tải phiên bản mới lên S3, sau đó cập nhật tên miền tùy chỉnh của bạn để sử dụng phiên bản mới. Để cập nhật kho tin cậy, bạn phải có quyền truy cập vào đối tượng S3

    • truststoreVersion [chuỗi] --

      Phiên bản của đối tượng S3 chứa cửa hàng tin cậy của bạn. Để chỉ định một phiên bản, bạn phải bật lập phiên bản cho bộ chứa S3

  • quyền sở hữuVerificationCertificateArn [chuỗi] -- ARN của chứng chỉ công khai do ACM cấp để xác thực quyền sở hữu miền tùy chỉnh của bạn. Chỉ bắt buộc khi định cấu hình TLS lẫn nhau và sử dụng ARN chứng chỉ CA riêng hoặc được nhập ACM làm ARNCertificateArn khu vực
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
344

Cấu trúc phản hồi

  • [chính tả] --

    Đại diện cho một tên miền tùy chỉnh dưới dạng tên máy chủ thân thiện với người dùng của API [RestApi]

    • domainName [string] --

      Tên miền tùy chỉnh dưới dạng tên máy chủ API, ví dụ:

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1436

    • tên chứng chỉ [chuỗi] --

      Tên của chứng chỉ sẽ được sử dụng bởi điểm cuối được tối ưu hóa cạnh cho tên miền này

    • chứng chỉArn [chuỗi] --

      Tham chiếu đến chứng chỉ do AWS quản lý sẽ được sử dụng bởi điểm cuối được tối ưu hóa cạnh cho tên miền này. AWS Certificate Manager là nguồn được hỗ trợ duy nhất

    • chứng chỉUploadDate [ngày giờ] --

      Dấu thời gian khi chứng chỉ được sử dụng bởi điểm cuối được tối ưu hóa cạnh cho tên miền này được tải lên

    • khu vựcDomainName [chuỗi] --

      Tên miền được liên kết với điểm cuối khu vực cho tên miền tùy chỉnh này. Bạn thiết lập liên kết này bằng cách thêm bản ghi DNS trỏ tên miền tùy chỉnh tới tên miền khu vực này. Tên miền khu vực được API Gateway trả về khi bạn tạo điểm cuối khu vực

    • khu vựcHostedZoneId [chuỗi] --

      ID khu vực được lưu trữ trên Amazon Route 53 dành riêng cho khu vực của điểm cuối khu vực. Để biết thêm thông tin, hãy xem Thiết lập tên miền tùy chỉnh khu vực và Khu vực AWS cũng như điểm cuối cho API Gateway

    • khu vựcCertificateName [chuỗi] --

      Tên của chứng chỉ sẽ được sử dụng để xác thực tên miền khu vực

    • khu vựcCertificateArn [chuỗi] --

      Tham chiếu đến chứng chỉ do AWS quản lý sẽ được sử dụng để xác thực tên miền khu vực. AWS Certificate Manager là nguồn được hỗ trợ duy nhất

    • phân phốiDomainName [chuỗi] --

      Tên miền của bản phân phối Amazon CloudFront được liên kết với tên miền tùy chỉnh này cho một điểm cuối được tối ưu hóa cho vùng biên. Bạn thiết lập liên kết này khi thêm bản ghi DNS trỏ tên miền tùy chỉnh vào tên phân phối này. Để biết thêm thông tin về các bản phân phối CloudFront, hãy xem tài liệu về Amazon CloudFront

    • phân phốiHostedZoneId [chuỗi] --

      ID khu vực được lưu trữ trên Amazon Route 53 không theo khu vực của điểm cuối được tối ưu hóa theo vùng biên. Giá trị hợp lệ là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1437 cho tất cả các vùng. Để biết thêm thông tin, hãy xem Thiết lập tên miền tùy chỉnh khu vực và Khu vực AWS cũng như điểm cuối cho API Gateway

    • endpointConfiguration [dict] --

      Cấu hình điểm cuối của Tên miền này hiển thị các loại điểm cuối của tên miền

      • loại [danh sách] --

        Danh sách các loại điểm cuối của API [RestApi] hoặc tên miền tùy chỉnh của nó [DomainName]. Đối với API được tối ưu hóa cạnh và tên miền tùy chỉnh của nó, loại điểm cuối là

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1425. Đối với API khu vực và tên miền tùy chỉnh của nó, loại điểm cuối là
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1426. Đối với API riêng tư, loại điểm cuối là
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1427

        • [chuỗi] --

          Loại điểm cuối. Các giá trị hợp lệ là

          {
              'id': 'string',
              'value': 'string',
              'name': 'string',
              'customerId': 'string',
              'description': 'string',
              'enabled': True|False,
              'createdDate': datetime[2015, 1, 1],
              'lastUpdatedDate': datetime[2015, 1, 1],
              'stageKeys': [
                  'string',
              ],
              'tags': {
                  'string': 'string'
              }
          }
          
          1428 để thiết lập API được tối ưu hóa cạnh, phù hợp nhất cho các ứng dụng dành cho thiết bị di động;

      • vpcEndpointIds [danh sách] --

        Danh sách các VpcEndpointId của một API [RestApi] để tạo các ALIAS của Route53. Nó chỉ được hỗ trợ cho loại điểm cuối

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1427

        • [chuỗi] --
    • domainNameStatus [chuỗi] --

      Trạng thái di chuyển Tên miền. Các giá trị hợp lệ là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1445 và
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1446. Nếu trạng thái là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1446 , miền không thể được sửa đổi thêm cho đến khi hoạt động hiện tại hoàn tất. Nếu là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1445 , tên miền có thể được cập nhật

    • domainNameStatusMessage [chuỗi] --

      Một tin nhắn văn bản tùy chọn chứa thông tin chi tiết về trạng thái di chuyển Tên miền

    • securityPolicy [chuỗi] --

      Phiên bản Transport Layer Security [TLS] + bộ mật mã cho Tên miền này. Các giá trị hợp lệ là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1433 và
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1434

    • thẻ [dict] --

      Bộ sưu tập các thẻ. Mỗi phần tử thẻ được liên kết với một tài nguyên nhất định

      • [chuỗi] --
        • [chuỗi] --
    • lẫn nhauTlsAuthentication [dict] --

      Cấu hình xác thực TLS lẫn nhau cho một tên miền tùy chỉnh. Nếu được chỉ định, API Gateway sẽ thực hiện xác thực hai chiều giữa máy khách và máy chủ. Khách hàng phải xuất trình chứng chỉ đáng tin cậy để truy cập API của bạn

      • truststoreUri [chuỗi] --

        URL Amazon S3 chỉ định kho tin cậy để xác thực TLS lẫn nhau, ví dụ:

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1435. Cửa hàng ủy thác có thể chứa các chứng chỉ từ cơ quan cấp chứng chỉ công cộng hoặc tư nhân. Để cập nhật cửa hàng tin cậy, hãy tải phiên bản mới lên S3, sau đó cập nhật tên miền tùy chỉnh của bạn để sử dụng phiên bản mới. Để cập nhật kho tin cậy, bạn phải có quyền truy cập vào đối tượng S3

      • truststoreVersion [chuỗi] --

        Phiên bản của đối tượng S3 chứa cửa hàng tin cậy của bạn. Để chỉ định một phiên bản, bạn phải bật lập phiên bản cho bộ chứa S3

      • truststoreWarnings [list] --

        Danh sách các cảnh báo mà API Gateway trả về trong khi xử lý cửa hàng ủy thác của bạn. Chứng chỉ không hợp lệ tạo cảnh báo. TLS lẫn nhau vẫn được bật, nhưng một số khách hàng có thể không truy cập được API của bạn. Để giải quyết các cảnh báo, hãy tải một cửa hàng tin cậy mới lên S3, sau đó cập nhật tên miền của bạn để sử dụng phiên bản mới

        • [chuỗi] --
    • quyền sở hữuVerificationCertificateArn [chuỗi] --

      ARN của chứng chỉ công khai do ACM cấp để xác thực quyền sở hữu miền tùy chỉnh của bạn. Chỉ bắt buộc khi định cấu hình TLS lẫn nhau và sử dụng ARN chứng chỉ CA riêng hoặc được nhập ACM làm ARNCertificateArn khu vực

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
1457 [ **kwargs ]

Thêm tài nguyên Mô hình mới vào tài nguyên RestApi hiện có

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
345

Thông số
  • restApiId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh RestApi mà Mô hình sẽ được tạo theo đó

  • tên [chuỗi] --

    [CẦN THIẾT]

    Tên của mô hình. Phải là chữ và số

  • description [string] -- Mô tả của mô hình
  • lược đồ [chuỗi] - Lược đồ cho mô hình. Đối với các mô hình
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    1458, đây phải là mô hình sơ thảo lược đồ JSON 4
  • kiểu nội dung [chuỗi] --

    [CẦN THIẾT]

    Loại nội dung cho mô hình

loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
346

Cấu trúc phản hồi

  • [chính tả] --

    Biểu thị cấu trúc dữ liệu của tải trọng yêu cầu hoặc phản hồi của một phương thức

    • id [chuỗi] --

      Mã định danh cho tài nguyên mô hình

    • tên [chuỗi] --

      Tên của mô hình. Phải là một chuỗi chữ và số

    • mô tả [chuỗi] --

      Mô tả của mô hình

    • lược đồ [chuỗi] --

      Lược đồ cho mô hình. Đối với các mô hình

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1458, đây phải là mô hình sơ thảo lược đồ JSON 4. Không bao gồm các ký tự "*/" trong phần mô tả của bất kỳ thuộc tính nào vì các ký tự "*/" đó có thể được hiểu là dấu đóng cho nhận xét ở một số ngôn ngữ, chẳng hạn như Java hoặc JavaScript, khiến việc cài đặt SDK API của bạn do API tạo ra

    • kiểu nội dung [chuỗi] --

      Loại nội dung cho mô hình

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
1466 [ **kwargs ]

Tạo một RequestValidator của một RestApi nhất định

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
347

Thông số
  • restApiId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh chuỗi của RestApi được liên kết

  • name [string] -- The name of the to-be-created RequestValidator
  • validateRequestBody [boolean] -- A Boolean flag to indicate whether to validate request body according to the configured model schema for the method [
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2905 ] or not [
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2906 ]
  • validateRequestParameters [boolean] -- Một cờ Boolean để cho biết có xác thực các tham số yêu cầu,
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2905 hay không
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2906
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
348

Cấu trúc phản hồi

  • [chính tả] --

    Một bộ quy tắc xác thực cho các yêu cầu Phương thức đến

    • id [chuỗi] --

      Mã định danh của RequestValidator này

    • tên [chuỗi] --

      Tên của RequestValidator này

    • xác thựcRequestBody [boolean] --

      Cờ Boolean để cho biết có xác thực phần thân yêu cầu theo lược đồ Mô hình đã định cấu hình hay không

    • xác thựcRequestParameters [boolean] --

      Cờ Boolean để cho biết có xác thực tham số yêu cầu [

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2905 ] hay không [
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2906 ]

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
1479 [ **kwargs ]

Tạo một tài nguyên Tài nguyên

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
349

Thông số
  • restApiId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh chuỗi của RestApi được liên kết

  • parentId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh của tài nguyên gốc

  • pathPart [chuỗi] --

    [CẦN THIẾT]

    Đoạn đường dẫn cuối cùng cho tài nguyên này

loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
0

Cấu trúc phản hồi

  • [chính tả] --

    Đại diện cho một tài nguyên API

    • id [chuỗi] --

      Mã định danh tài nguyên

    • parentId [chuỗi] --

      Mã định danh của tài nguyên gốc

    • pathPart [chuỗi] --

      Đoạn đường dẫn cuối cùng cho tài nguyên này

    • đường dẫn [chuỗi] --

      Đường dẫn đầy đủ cho tài nguyên này

    • resourceMethods [dict] --

      Nhận phương thức của tài nguyên API của một động từ HTTP đã cho

      • [chuỗi] --

        • [chính tả] --

          Đại diện cho giao diện hướng tới khách hàng mà khách hàng gọi API để truy cập tài nguyên phụ trợ. Tài nguyên Phương thức được tích hợp với tài nguyên Tích hợp. Cả hai đều bao gồm một yêu cầu và một hoặc nhiều phản hồi. Yêu cầu phương thức đưa đầu vào của máy khách được chuyển đến mặt sau thông qua yêu cầu tích hợp. Phản hồi của phương thức trả về đầu ra từ mặt sau cho máy khách thông qua phản hồi tích hợp. Yêu cầu phương thức được thể hiện trong tài nguyên Phương thức, trong khi yêu cầu tích hợp được thể hiện trong tài nguyên Tích hợp. Mặt khác, phản hồi phương thức được biểu thị bằng tài nguyên MethodResponse, trong khi phản hồi tích hợp được biểu thị bằng tài nguyên IntegrationResponse

          • httpMethod [chuỗi] --

            Động từ HTTP của phương thức

          • loại ủy quyền [chuỗi] --

            Loại ủy quyền của phương thức. Các giá trị hợp lệ là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2988 để truy cập mở,
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2989 để sử dụng quyền AWS IAM,
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2990 để sử dụng trình ủy quyền tùy chỉnh hoặc
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2918 để sử dụng nhóm người dùng Cognito

          • ủy quyềnId [chuỗi] --

            Mã định danh của Người ủy quyền để sử dụng trên phương thức này.

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1484 phải là
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2990

          • apiKeyRequired [boolean] --

            Cờ boolean chỉ định xem có cần phải có ApiKey hợp lệ để gọi phương thức này hay không

          • requestValidatorId [chuỗi] --

            Mã định danh của RequestValidator để xác thực yêu cầu

          • tên hoạt động [chuỗi] --

            Một định danh hoạt động thân thiện với con người cho phương pháp. Ví dụ: bạn có thể gán

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1486 của
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1487 cho phương thức
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1488 trong ví dụ về
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1489

          • requestParameters [dict] --

            Bản đồ khóa-giá trị xác định các tham số yêu cầu phương thức bắt buộc hoặc tùy chọn có thể được API Gateway chấp nhận. Khóa là tên tham số yêu cầu phương thức khớp với mẫu của

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1490 , trong đó
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1328 là
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1492 ,
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2928 hoặc
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1494 và
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            1495 là tên tham số hợp lệ và duy nhất. Giá trị được liên kết với khóa là cờ Boolean cho biết tham số là bắt buộc [
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2905 ] hay tùy chọn [
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2906 ]. Các tên tham số yêu cầu phương thức được xác định ở đây có sẵn trong Tích hợp để được ánh xạ tới các tham số hoặc mẫu yêu cầu tích hợp

            • [chuỗi] --
              • [boolean] --
          • requestModels [dict] --

            Bản đồ khóa-giá trị chỉ định lược đồ dữ liệu, được biểu thị bằng tài nguyên Mô hình, [dưới dạng giá trị được ánh xạ] của tải trọng yêu cầu của các loại nội dung nhất định [dưới dạng khóa ánh xạ]

            • [chuỗi] --
              • [chuỗi] --
          • methodResponses [dict] --

            Nhận phản hồi phương thức được liên kết với mã trạng thái HTTP đã cho

            • [chuỗi] --

              • [chính tả] --

                Thể hiện phản hồi phương thức của mã trạng thái HTTP đã cho được trả về máy khách. Phản hồi của phương thức được truyền từ mặt sau thông qua phản hồi tích hợp được liên kết có thể được chuyển đổi bằng cách sử dụng mẫu ánh xạ

                • mã trạng thái [chuỗi] --

                  Mã trạng thái của phản hồi phương thức

                • responseParameters [dict] --

                  Bản đồ khóa-giá trị chỉ định các tham số phản hồi bắt buộc hoặc tùy chọn mà API Gateway có thể gửi lại cho người gọi. Một khóa xác định tiêu đề phản hồi của phương thức và giá trị chỉ định xem tiêu đề phản hồi của phương thức được liên kết có bắt buộc hay không. Biểu thức của khóa phải khớp với mẫu

                  {
                      'id': 'string',
                      'value': 'string',
                      'name': 'string',
                      'customerId': 'string',
                      'description': 'string',
                      'enabled': True|False,
                      'createdDate': datetime[2015, 1, 1],
                      'lastUpdatedDate': datetime[2015, 1, 1],
                      'stageKeys': [
                          'string',
                      ],
                      'tags': {
                          'string': 'string'
                      }
                  }
                  
                  1498 , trong đó
                  {
                      'id': 'string',
                      'value': 'string',
                      'name': 'string',
                      'customerId': 'string',
                      'description': 'string',
                      'enabled': True|False,
                      'createdDate': datetime[2015, 1, 1],
                      'lastUpdatedDate': datetime[2015, 1, 1],
                      'stageKeys': [
                          'string',
                      ],
                      'tags': {
                          'string': 'string'
                      }
                  }
                  
                  1495 là tên tiêu đề hợp lệ và duy nhất. Cổng API chuyển dữ liệu phản hồi tích hợp nhất định tới tiêu đề phản hồi của phương thức được chỉ định tại đây theo ánh xạ mà bạn quy định trong Phản hồi tích hợp của API. Dữ liệu phản hồi tích hợp có thể được ánh xạ bao gồm tiêu đề phản hồi tích hợp được biểu thị bằng
                  {
                      'id': 'string',
                      'value': 'string',
                      'name': 'string',
                      'customerId': 'string',
                      'description': 'string',
                      'enabled': True|False,
                      'createdDate': datetime[2015, 1, 1],
                      'lastUpdatedDate': datetime[2015, 1, 1],
                      'stageKeys': [
                          'string',
                      ],
                      'tags': {
                          'string': 'string'
                      }
                  }
                  
                  2200 , một giá trị tĩnh được đặt trong một cặp dấu nháy đơn [e. g. ,
                  {
                      'id': 'string',
                      'value': 'string',
                      'name': 'string',
                      'customerId': 'string',
                      'description': 'string',
                      'enabled': True|False,
                      'createdDate': datetime[2015, 1, 1],
                      'lastUpdatedDate': datetime[2015, 1, 1],
                      'stageKeys': [
                          'string',
                      ],
                      'tags': {
                          'string': 'string'
                      }
                  }
                  
                  2201 ] hoặc biểu thức JSON từ tải trọng phản hồi back-end ở dạng
                  {
                      'id': 'string',
                      'value': 'string',
                      'name': 'string',
                      'customerId': 'string',
                      'description': 'string',
                      'enabled': True|False,
                      'createdDate': datetime[2015, 1, 1],
                      'lastUpdatedDate': datetime[2015, 1, 1],
                      'stageKeys': [
                          'string',
                      ],
                      'tags': {
                          'string': 'string'
                      }
                  }
                  
                  2202 , trong đó
                  {
                      'id': 'string',
                      'value': 'string',
                      'name': 'string',
                      'customerId': 'string',
                      'description': 'string',
                      'enabled': True|False,
                      'createdDate': datetime[2015, 1, 1],
                      'lastUpdatedDate': datetime[2015, 1, 1],
                      'stageKeys': [
                          'string',
                      ],
                      'tags': {
                          'string': 'string'
                      }
                  }
                  
                  2203 là biểu thức JSON hợp lệ không có tiền tố
                  {
                      'id': 'string',
                      'value': 'string',
                      'name': 'string',
                      'customerId': 'string',
                      'description': 'string',
                      'enabled': True|False,
                      'createdDate': datetime[2015, 1, 1],
                      'lastUpdatedDate': datetime[2015, 1, 1],
                      'stageKeys': [
                          'string',
                      ],
                      'tags': {
                          'string': 'string'
                      }
                  }
                  
                  2204. ]

                  • [chuỗi] --
                    • [boolean] --
                • responseModels [dict] --

                  Chỉ định tài nguyên Mô hình được sử dụng cho loại nội dung của phản hồi. Các mô hình phản hồi được biểu diễn dưới dạng bản đồ khóa/giá trị, với loại nội dung làm khóa và tên Mô hình làm giá trị

                  • [chuỗi] --
                    • [chuỗi] --
          • methodIntegration [dict] --

            Nhận phần tích hợp của phương thức chịu trách nhiệm chuyển yêu cầu do khách hàng gửi đến mặt sau và thực hiện các chuyển đổi cần thiết để làm cho yêu cầu tuân thủ mặt sau

            • loại [chuỗi] --

              Chỉ định loại tích hợp phương thức API. Giá trị hợp lệ là một trong những giá trị sau

              Đối với tích hợp proxy HTTP và HTTP, mỗi tích hợp có thể chỉ định một giao thức [

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2205 ], cổng và đường dẫn. Các cổng tiêu chuẩn 80 và 443 được hỗ trợ cũng như các cổng tùy chỉnh trên 1024. Tích hợp proxy HTTP hoặc HTTP với
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2206 của
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2207 được gọi là tích hợp riêng tư và sử dụng VpcLink để kết nối API Gateway với bộ cân bằng tải mạng của VPC

            • httpMethod [chuỗi] --

              Chỉ định loại phương thức HTTP của tích hợp

            • uri [chuỗi] --

              Chỉ định Mã định danh tài nguyên thống nhất [URI] của điểm cuối tích hợp

              Đối với các tích hợp

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2208 hoặc
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2209, URI phải là một URL HTTP[S] được mã hóa, tạo đầy đủ theo đặc tả RFC-3986, đối với tích hợp tiêu chuẩn, trong đó
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2206 không phải là
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2207 hoặc tích hợp riêng tư, trong đó
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2206 là
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2207. Đối với tích hợp HTTP riêng tư, URI không được sử dụng để định tuyến. Đối với tích hợp
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2214 hoặc
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2215, URI có dạng
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2216. Ở đây, {Region} là khu vực Cổng API [e. g. , mỹ-đông-1]; . g. , s3]; and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}. query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. Service_api tiếp theo đề cập đến đường dẫn đến tài nguyên dịch vụ Amazon Web Services, bao gồm khu vực của dịch vụ Amazon Web Services tích hợp, nếu có. Ví dụ: để tích hợp với API S3 của GetObject, uri có thể là
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2217 hoặc
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2218

            • loại kết nối [chuỗi] --

              The type of the network connection to the integration endpoint. The valid value is

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2219 for connections through the public routable internet or
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2207 for private connections between API Gateway and a network load balancer in a VPC. The default value is
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2219

            • connectionId [string] --

              The ID of the VpcLink used for the integration when

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2222 and undefined, otherwise

            • credentials [string] --

              Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name [ARN]. To require that the caller's identity be passed through from the request, specify the string

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2223 . To use resource-based permissions on supported AWS services, specify null

            • requestParameters [dict] --

              A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              1490 , where
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              1328 is
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              1492 ,
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2928 , or
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              1494 and
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              1495 must be a valid and unique method request parameter name

              • [chuỗi] --
                • [chuỗi] --
            • requestTemplates [dict] --

              Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template [as a String] is the value

              • [chuỗi] --
                • [chuỗi] --
            • passthroughBehavior [string] --

              Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2230 . The valid value is one of the following.
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2231 . passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2232 . passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2233 . rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request

            • contentHandling [string] --

              Specifies how to handle request payload content type conversions. Supported values are

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2234 and
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2235 , with the following behaviors

              If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2236 is configured to support payload pass-through

            • timeoutInMillis [integer] --

              Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds

            • cacheNamespace [string] --

              Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2237 . You can specify the same
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2237 across resources to return the same cached data for requests to different resources

            • cacheKeyParameters [list] --

              A list of request parameters whose values API Gateway caches. To be valid values for

              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2239 , these parameters must also be specified for Method
              {
                  'id': 'string',
                  'value': 'string',
                  'name': 'string',
                  'customerId': 'string',
                  'description': 'string',
                  'enabled': True|False,
                  'createdDate': datetime[2015, 1, 1],
                  'lastUpdatedDate': datetime[2015, 1, 1],
                  'stageKeys': [
                      'string',
                  ],
                  'tags': {
                      'string': 'string'
                  }
              }
              
              2240

              • [chuỗi] --
            • integrationResponses [dict] --

              Specifies the integration's responses

              • [chuỗi] --

                • [chính tả] --

                  Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response

                  • mã trạng thái [chuỗi] --

                    Specifies the status code that is used to map the integration response to an existing MethodResponse

                  • selectionPattern [string] --

                    Specifies the regular expression [regex] pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the

                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    2241 regex to match error response. However, make sure that the error response does not contain any newline [
                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    2242 ] character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched

                  • responseParameters [dict] --

                    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of

                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    1498 , where
                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    1495 is a valid and unique header name. The mapped non-static value must match the pattern of
                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    2200 or
                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    2202 , where
                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    1495 is a valid and unique response header name and
                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    2203 is a valid JSON expression without the
                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    2204 prefix

                    • [chuỗi] --
                      • [chuỗi] --
                  • phản hồiTemplates [dict] --

                    Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value

                    • [chuỗi] --
                      • [chuỗi] --
                  • contentHandling [string] --

                    Specifies how to handle response payload content type conversions. Supported values are

                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    2234 and
                    {
                        'id': 'string',
                        'value': 'string',
                        'name': 'string',
                        'customerId': 'string',
                        'description': 'string',
                        'enabled': True|False,
                        'createdDate': datetime[2015, 1, 1],
                        'lastUpdatedDate': datetime[2015, 1, 1],
                        'stageKeys': [
                            'string',
                        ],
                        'tags': {
                            'string': 'string'
                        }
                    }
                    
                    2235 , with the following behaviors

                    If this property is not defined, the response payload will be passed through from the integration response to the method response without modification

            • tlsConfig [dict] --

              Specifies the TLS configuration for an integration

              • insecureSkipVerification [boolean] --

                Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for

                {
                    'id': 'string',
                    'value': 'string',
                    'name': 'string',
                    'customerId': 'string',
                    'description': 'string',
                    'enabled': True|False,
                    'createdDate': datetime[2015, 1, 1],
                    'lastUpdatedDate': datetime[2015, 1, 1],
                    'stageKeys': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    }
                }
                
                2208 and
                {
                    'id': 'string',
                    'value': 'string',
                    'name': 'string',
                    'customerId': 'string',
                    'description': 'string',
                    'enabled': True|False,
                    'createdDate': datetime[2015, 1, 1],
                    'lastUpdatedDate': datetime[2015, 1, 1],
                    'stageKeys': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    }
                }
                
                2209 integrations

                Warning

                Enabling

                {
                    'id': 'string',
                    'value': 'string',
                    'name': 'string',
                    'customerId': 'string',
                    'description': 'string',
                    'enabled': True|False,
                    'createdDate': datetime[2015, 1, 1],
                    'lastUpdatedDate': datetime[2015, 1, 1],
                    'stageKeys': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    }
                }
                
                2254 isn't recommended, especially for integrations with public HTTPS endpoints. If you enable
                {
                    'id': 'string',
                    'value': 'string',
                    'name': 'string',
                    'customerId': 'string',
                    'description': 'string',
                    'enabled': True|False,
                    'createdDate': datetime[2015, 1, 1],
                    'lastUpdatedDate': datetime[2015, 1, 1],
                    'stageKeys': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    }
                }
                
                2254 , you increase the risk of man-in-the-middle attacks

          • authorizationScopes [list] --

            A list of authorization scopes configured on the method. The scopes are used with a

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2918 authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes

            • [chuỗi] --

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2263 [ **kwargs ]

Creates a new RestApi resource

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
1

Thông số
  • tên [chuỗi] --

    [CẦN THIẾT]

    The name of the RestApi

  • description [string] -- The description of the RestApi
  • version [string] -- A version identifier for the API
  • cloneFrom [string] -- ID của RestApi mà bạn muốn sao chép từ đó
  • binaryMediaTypes [list] --

    The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads

    • [chuỗi] --
  • minimumCompressionSize [integer] -- A nullable integer that is used to enable compression [with non-negative between 0 and 10485760 [10M] bytes, inclusive] or disable compression [with a null value] on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size
  • apiKeySource [string] -- The source of the API key for metering requests according to a usage plan. Valid values are. >
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2264 to read the API key from the
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2265 header of a request.
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    1301 to read the API key from the
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2267 from a custom authorizer
  • endpointConfiguration [dict] --

    The endpoint configuration of this RestApi showing the endpoint types of the API

    • loại [danh sách] --

      Danh sách các loại điểm cuối của API [RestApi] hoặc tên miền tùy chỉnh của nó [DomainName]. Đối với API được tối ưu hóa cạnh và tên miền tùy chỉnh của nó, loại điểm cuối là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1425. Đối với API khu vực và tên miền tùy chỉnh của nó, loại điểm cuối là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1426. Đối với API riêng tư, loại điểm cuối là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1427

      • [chuỗi] --

        Loại điểm cuối. Các giá trị hợp lệ là

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1428 để thiết lập API được tối ưu hóa cạnh, phù hợp nhất cho các ứng dụng dành cho thiết bị di động;

    • vpcEndpointIds [danh sách] --

      Danh sách các VpcEndpointId của một API [RestApi] để tạo các ALIAS của Route53. Nó chỉ được hỗ trợ cho loại điểm cuối

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1427

      • [chuỗi] --
  • policy [string] -- A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration
  • thẻ [dict] --

    Bản đồ khóa-giá trị của chuỗi. Bộ ký tự hợp lệ là [a-zA-Z+-=. _. /]. Khóa thẻ có thể dài tối đa 128 ký tự và không được bắt đầu bằng

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2908. Giá trị thẻ có thể lên tới 256 ký tự

    • [chuỗi] --
      • [chuỗi] --
  • disableExecuteApiEndpoint [boolean] -- Specifies whether clients can invoke your API by using the default
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2276 endpoint. By default, clients can invoke your API with the default
    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2277 endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2

Cấu trúc phản hồi

  • [chính tả] --

    Represents a REST API

    • id [chuỗi] --

      The API's identifier. This identifier is unique across all of your APIs in API Gateway

    • tên [chuỗi] --

      The API's name

    • mô tả [chuỗi] --

      The API's description

    • ngày tạo [ngày giờ] --

      The timestamp when the API was created

    • phiên bản [chuỗi] --

      A version identifier for the API

    • warnings [list] --

      The warning messages reported when

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2278 is turned on during API import

      • [chuỗi] --
    • binaryMediaTypes [list] --

      The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads

      • [chuỗi] --
    • minimumCompressionSize [integer] --

      A nullable integer that is used to enable compression [with non-negative between 0 and 10485760 [10M] bytes, inclusive] or disable compression [with a null value] on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Đặt nó thành 0 cho phép nén cho bất kỳ kích thước tải trọng nào

    • apiKeySource [string] --

      The source of the API key for metering requests according to a usage plan. Valid values are. >

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2264 to read the API key from the
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2265 header of a request.
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1301 to read the API key from the
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2267 from a custom authorizer

    • endpointConfiguration [dict] --

      The endpoint configuration of this RestApi showing the endpoint types of the API

      • loại [danh sách] --

        Danh sách các loại điểm cuối của API [RestApi] hoặc tên miền tùy chỉnh của nó [DomainName]. Đối với API được tối ưu hóa cạnh và tên miền tùy chỉnh của nó, loại điểm cuối là

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1425. Đối với API khu vực và tên miền tùy chỉnh của nó, loại điểm cuối là
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1426. Đối với API riêng tư, loại điểm cuối là
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1427

        • [chuỗi] --

          Loại điểm cuối. Các giá trị hợp lệ là

          {
              'id': 'string',
              'value': 'string',
              'name': 'string',
              'customerId': 'string',
              'description': 'string',
              'enabled': True|False,
              'createdDate': datetime[2015, 1, 1],
              'lastUpdatedDate': datetime[2015, 1, 1],
              'stageKeys': [
                  'string',
              ],
              'tags': {
                  'string': 'string'
              }
          }
          
          1428 để thiết lập API được tối ưu hóa cạnh, phù hợp nhất cho các ứng dụng dành cho thiết bị di động;

      • vpcEndpointIds [danh sách] --

        Danh sách các VpcEndpointId của một API [RestApi] để tạo các ALIAS của Route53. Nó chỉ được hỗ trợ cho loại điểm cuối

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        1427

        • [chuỗi] --
    • policy [string] --

      A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration

    • thẻ [dict] --

      Bộ sưu tập các thẻ. Mỗi phần tử thẻ được liên kết với một tài nguyên nhất định

      • [chuỗi] --
        • [chuỗi] --
    • disableExecuteApiEndpoint [boolean] --

      Specifies whether clients can invoke your API by using the default

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2276 endpoint. By default, clients can invoke your API with the default
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2277 endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2297 [ **kwargs ]

Creates a new Stage resource that references a pre-existing Deployment for the API

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
3

Thông số
  • restApiId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh chuỗi của RestApi được liên kết

  • tên sân khấu [chuỗi] --

    [CẦN THIẾT]

    The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters

  • deploymentId [string] --

    [CẦN THIẾT]

    The identifier of the Deployment resource for the Stage resource

  • description [string] -- The description of the Stage resource
  • cacheClusterEnabled [boolean] -- Whether cache clustering is enabled for the stage
  • cacheClusterSize [string] -- Kích thước cụm bộ đệm của giai đoạn
  • biến [dict] --

    Bản đồ xác định các biến giai đoạn cho tài nguyên Giai đoạn mới. Tên biến có thể có ký tự chữ và số và dấu gạch dưới và các giá trị phải khớp với

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2987

    • [chuỗi] --
      • [chuỗi] --
  • documentationVersion [string] -- Phiên bản của tài liệu API được liên kết
  • canarySettings [dict] --

    Cài đặt triển khai canary của giai đoạn này

    • phần trămTraffic [thả nổi] --

      Phần trăm [0-100] lưu lượng truy cập được chuyển hướng sang triển khai canary

    • deploymentId [string] --

      ID triển khai canary

    • stageVariableOverrides [dict] --

      Các biến giai đoạn được ghi đè để triển khai bản phát hành canary, bao gồm các biến giai đoạn mới được giới thiệu trong canary. Các biến giai đoạn này được biểu diễn dưới dạng ánh xạ chuỗi thành chuỗi giữa tên biến giai đoạn và giá trị của chúng

      • [chuỗi] --
        • [chuỗi] --
    • useStageCache [boolean] --

      Một cờ Boolean để cho biết việc triển khai canary có sử dụng bộ đệm giai đoạn hay không

  • tracingEnabled [boolean] -- Chỉ định xem có bật chức năng theo dõi chủ động bằng tia X cho Giai đoạn hay không
  • thẻ [dict] --

    Bản đồ khóa-giá trị của chuỗi. Bộ ký tự hợp lệ là [a-zA-Z+-=. _. /]. Khóa thẻ có thể dài tối đa 128 ký tự và không được bắt đầu bằng

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2908. Giá trị thẻ có thể lên tới 256 ký tự

    • [chuỗi] --
      • [chuỗi] --
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
4

Cấu trúc phản hồi

  • [chính tả] --

    Đại diện cho một mã định danh duy nhất cho một phiên bản RestApi đã triển khai mà người dùng có thể gọi được

    • deploymentId [string] --

      Mã định danh của Triển khai mà giai đoạn trỏ đến

    • clientCertificateId [chuỗi] --

      Mã định danh của chứng chỉ ứng dụng khách cho giai đoạn API

    • tên sân khấu [chuỗi] --

      Tên của giai đoạn là đoạn đường dẫn đầu tiên trong Mã định danh tài nguyên đồng nhất [URI] của lệnh gọi tới Cổng API. Tên giai đoạn chỉ có thể chứa các ký tự chữ và số, dấu gạch nối và dấu gạch dưới. Độ dài tối đa là 128 ký tự

    • mô tả [chuỗi] --

      Mô tả sân khấu

    • cacheClusterEnabled [boolean] --

      Chỉ định xem cụm bộ đệm có được bật cho giai đoạn hay không

    • cacheClusterSize [chuỗi] --

      Kích thước của cụm bộ đệm cho giai đoạn, nếu được bật

    • cacheClusterStatus [chuỗi] --

      Trạng thái của cụm bộ đệm cho giai đoạn, nếu được bật

    • methodSettings [dict] --

      Bản đồ xác định cài đặt phương thức cho tài nguyên Giai đoạn. Các khóa [được chỉ định là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2400 bên dưới] là các đường dẫn phương thức được xác định là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2401 để ghi đè một phương thức riêng lẻ hoặc
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2402 để ghi đè tất cả các phương thức trong giai đoạn

      • [chuỗi] --

        • [chính tả] --

          Chỉ định các thuộc tính cài đặt phương thức

          • số liệu đã bật [boolean] --

            Chỉ định liệu số liệu Amazon CloudWatch có được bật cho phương pháp này hay không. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2403 và giá trị là Boolean

          • logLevel [chuỗi] --

            Chỉ định cấp độ ghi nhật ký cho phương pháp này, ảnh hưởng đến các mục nhập nhật ký được đẩy tới Amazon CloudWatch Logs. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2404 và các mức khả dụng là
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2405 ,
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2406 và
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2407. Chọn
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2406 để chỉ ghi các mục ở cấp độ lỗi vào Nhật ký CloudWatch hoặc chọn
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2407 để bao gồm tất cả các sự kiện
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2406 cũng như các sự kiện bổ sung thông tin

          • dataTraceEnabled [boolean] --

            Chỉ định xem có bật ghi nhật ký theo dõi dữ liệu cho phương thức này hay không, điều này ảnh hưởng đến các mục nhập nhật ký được đẩy tới Amazon CloudWatch Logs. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2411 và giá trị là Boolean

          • throttlingBurstLimit [số nguyên] --

            Chỉ định giới hạn bùng nổ tiết lưu. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2412 và giá trị là một số nguyên

          • throttlingRateLimit [thả nổi] --

            Chỉ định giới hạn tốc độ điều tiết. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2413 và giá trị là gấp đôi

          • cachingEnabled [boolean] --

            Chỉ định xem các phản hồi có nên được lưu vào bộ đệm và trả lại cho các yêu cầu hay không. Một cụm bộ đệm phải được bật trên sân khấu để các phản hồi được lưu vào bộ đệm. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2414 và giá trị là Boolean

          • cacheTtlInSeconds [số nguyên] --

            Chỉ định thời gian tồn tại [TTL], tính bằng giây, cho các phản hồi được lưu trong bộ nhớ cache. TTL càng cao, phản hồi sẽ được lưu vào bộ đệm càng lâu. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2415 và giá trị là một số nguyên

          • cacheDataEncrypted [boolean] --

            Chỉ định xem các phản hồi được lưu trong bộ nhớ cache có được mã hóa hay không. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2416 và giá trị là Boolean

          • requireAuthorizationForCacheControl [boolean] --

            Chỉ định xem có cần ủy quyền cho yêu cầu vô hiệu hóa bộ nhớ cache hay không. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2417 và giá trị là Boolean

          • trái phépCacheControlHeaderStrategy [chuỗi] --

            Chỉ định cách xử lý các yêu cầu trái phép để vô hiệu hóa bộ đệm. Đường dẫn PATCH cho cài đặt này là

            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2418 và các giá trị khả dụng là
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2419,
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2420,
            {
                'id': 'string',
                'value': 'string',
                'name': 'string',
                'customerId': 'string',
                'description': 'string',
                'enabled': True|False,
                'createdDate': datetime[2015, 1, 1],
                'lastUpdatedDate': datetime[2015, 1, 1],
                'stageKeys': [
                    'string',
                ],
                'tags': {
                    'string': 'string'
                }
            }
            
            2421

    • biến [dict] --

      Bản đồ xác định các biến giai đoạn cho tài nguyên Giai đoạn. Tên biến có thể có ký tự chữ và số và dấu gạch dưới và các giá trị phải khớp với

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2987

      • [chuỗi] --
        • [chuỗi] --
    • tài liệuVersion [chuỗi] --

      Phiên bản của tài liệu API được liên kết

    • accessLogSettings [dict] --

      Cài đặt để truy cập nhật ký trong giai đoạn này

      • định dạng [chuỗi] --

        Định dạng một dòng của nhật ký truy cập dữ liệu, như được chỉ định bởi các biến $context đã chọn. Định dạng phải bao gồm ít nhất

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        2423

      • đíchArn [chuỗi] --

        Tên tài nguyên Amazon [ARN] của nhóm nhật ký CloudWatch Logs hoặc luồng phân phối Kinesis Data Firehose để nhận nhật ký truy cập. Nếu bạn chỉ định luồng phân phối Kinesis Data Firehose, thì tên luồng phải bắt đầu bằng

        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime[2015, 1, 1],
            'lastUpdatedDate': datetime[2015, 1, 1],
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        }
        
        2424

    • canarySettings [dict] --

      Cài đặt cho việc triển khai canary trong giai đoạn này

      • phần trămTraffic [thả nổi] --

        Phần trăm [0-100] lưu lượng truy cập được chuyển hướng sang triển khai canary

      • deploymentId [string] --

        ID triển khai canary

      • stageVariableOverrides [dict] --

        Các biến giai đoạn được ghi đè để triển khai bản phát hành canary, bao gồm các biến giai đoạn mới được giới thiệu trong canary. Các biến giai đoạn này được biểu diễn dưới dạng ánh xạ chuỗi thành chuỗi giữa tên biến giai đoạn và giá trị của chúng

        • [chuỗi] --
          • [chuỗi] --
      • useStageCache [boolean] --

        Một cờ Boolean để cho biết việc triển khai canary có sử dụng bộ đệm giai đoạn hay không

    • tracingEnabled [boolean] --

      Chỉ định xem có bật theo dõi chủ động bằng tia X cho Giai đoạn hay không

    • webAclArn [chuỗi] --

      ARN của WebAcl được liên kết với Giai đoạn

    • thẻ [dict] --

      Bộ sưu tập các thẻ. Mỗi phần tử thẻ được liên kết với một tài nguyên nhất định

      • [chuỗi] --
        • [chuỗi] --
    • ngày tạo [ngày giờ] --

      Dấu thời gian khi giai đoạn được tạo

    • lastUpdatedDate [ngày giờ] --

      Dấu thời gian khi giai đoạn được cập nhật lần cuối

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2431 [ **kwargs ]

Tạo kế hoạch sử dụng với giới hạn hạn ngạch và điều tiết, cũng như các giai đoạn API được liên kết, được chỉ định trong tải trọng

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
5

Thông số
  • tên [chuỗi] --

    [CẦN THIẾT]

    Tên kế hoạch sử dụng

  • description [string] -- Mô tả kế hoạch sử dụng
  • apiStages [danh sách] --

    Các giai đoạn API liên quan của kế hoạch sử dụng

    • [chính tả] --

      Tên giai đoạn API của giai đoạn API được liên kết trong kế hoạch sử dụng

      • apiId [chuỗi] --

        Id API của giai đoạn API được liên kết trong kế hoạch sử dụng

      • sân khấu [chuỗi] --

        Tên giai đoạn API của giai đoạn API được liên kết trong kế hoạch sử dụng

      • van tiết lưu [dict] --

        Bản đồ chứa thông tin điều chỉnh mức phương thức cho giai đoạn API trong kế hoạch sử dụng

        • [chuỗi] --
          • [chính tả] --

            Giới hạn tỷ lệ yêu cầu API

            • burstLimit [số nguyên] --

              Giới hạn tốc độ bùng nổ yêu cầu mục tiêu API. Điều này cho phép nhiều yêu cầu hơn trong một khoảng thời gian hơn giới hạn tốc độ mục tiêu

            • rateLimit [thả nổi] --

              Giới hạn tỷ lệ yêu cầu mục tiêu API

  • van tiết lưu [dict] --

    Các giới hạn điều tiết của kế hoạch sử dụng

    • burstLimit [số nguyên] --

      Giới hạn tốc độ bùng nổ yêu cầu mục tiêu API. Điều này cho phép nhiều yêu cầu hơn trong một khoảng thời gian hơn giới hạn tốc độ mục tiêu

    • rateLimit [thả nổi] --

      Giới hạn tỷ lệ yêu cầu mục tiêu API

  • hạn ngạch [dict] --

    Định mức của kế hoạch sử dụng

    • giới hạn [số nguyên] --

      Số lượng yêu cầu tối đa mục tiêu có thể được thực hiện trong một khoảng thời gian nhất định

    • phần bù [số nguyên] --

      Số lượng yêu cầu bị trừ khỏi giới hạn nhất định trong khoảng thời gian ban đầu

    • dấu chấm [chuỗi] --

      Khoảng thời gian áp dụng giới hạn. Các giá trị hợp lệ là "NGÀY", "TUẦN" hoặc "THÁNG"

  • thẻ [dict] --

    Bản đồ khóa-giá trị của chuỗi. Bộ ký tự hợp lệ là [a-zA-Z+-=. _. /]. Khóa thẻ có thể dài tối đa 128 ký tự và không được bắt đầu bằng

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2908. Giá trị thẻ có thể lên tới 256 ký tự

    • [chuỗi] --
      • [chuỗi] --
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
6

Cấu trúc phản hồi

  • [chính tả] --

    Thể hiện kế hoạch sử dụng được sử dụng để chỉ định ai có thể đánh giá các giai đoạn API được liên kết. Tùy chọn, có thể đặt tỷ lệ yêu cầu mục tiêu và giới hạn hạn ngạch. Trong một số trường hợp, khách hàng có thể vượt chỉ tiêu mà bạn đặt ra. Đừng dựa vào kế hoạch sử dụng để kiểm soát chi phí. Cân nhắc sử dụng Ngân sách dịch vụ web của Amazon để theo dõi chi phí và WAF để quản lý các yêu cầu API

    • id [chuỗi] --

      Mã định danh của tài nguyên Kế hoạch sử dụng

    • tên [chuỗi] --

      Tên kế hoạch sử dụng

    • mô tả [chuỗi] --

      Mô tả kế hoạch sử dụng

    • apiStages [danh sách] --

      Các giai đoạn API được liên kết của kế hoạch sử dụng

      • [chính tả] --

        Tên giai đoạn API của giai đoạn API được liên kết trong kế hoạch sử dụng

        • apiId [chuỗi] --

          Id API của giai đoạn API được liên kết trong kế hoạch sử dụng

        • sân khấu [chuỗi] --

          Tên giai đoạn API của giai đoạn API được liên kết trong kế hoạch sử dụng

        • van tiết lưu [dict] --

          Bản đồ chứa thông tin điều chỉnh mức phương thức cho giai đoạn API trong kế hoạch sử dụng

          • [chuỗi] --

            • [chính tả] --

              Giới hạn tỷ lệ yêu cầu API

              • burstLimit [số nguyên] --

                Giới hạn tốc độ bùng nổ yêu cầu mục tiêu API. Điều này cho phép nhiều yêu cầu hơn trong một khoảng thời gian hơn giới hạn tốc độ mục tiêu

              • rateLimit [thả nổi] --

                Giới hạn tỷ lệ yêu cầu mục tiêu API

    • van tiết lưu [dict] --

      Bản đồ chứa thông tin điều chỉnh mức phương thức cho giai đoạn API trong kế hoạch sử dụng

      • burstLimit [số nguyên] --

        Giới hạn tốc độ bùng nổ yêu cầu mục tiêu API. Điều này cho phép nhiều yêu cầu hơn trong một khoảng thời gian hơn giới hạn tốc độ mục tiêu

      • rateLimit [thả nổi] --

        Giới hạn tỷ lệ yêu cầu mục tiêu API

    • hạn ngạch [dict] --

      Số lượng yêu cầu được phép tối đa mục tiêu trên một khoảng thời gian đơn vị nhất định

      • giới hạn [số nguyên] --

        Số lượng yêu cầu tối đa mục tiêu có thể được thực hiện trong một khoảng thời gian nhất định

      • phần bù [số nguyên] --

        Số lượng yêu cầu bị trừ khỏi giới hạn nhất định trong khoảng thời gian ban đầu

      • dấu chấm [chuỗi] --

        Khoảng thời gian áp dụng giới hạn. Các giá trị hợp lệ là "NGÀY", "TUẦN" hoặc "THÁNG"

    • mã sản phẩm [chuỗi] --

      Mã định danh sản phẩm AWS Marketplace để liên kết với gói sử dụng dưới dạng sản phẩm SaaS trên AWS Marketplace

    • thẻ [dict] --

      Bộ sưu tập các thẻ. Mỗi phần tử thẻ được liên kết với một tài nguyên nhất định

      • [chuỗi] --
        • [chuỗi] --

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2439 [ **kwargs ]

Tạo khóa gói sử dụng để thêm khóa API hiện có vào gói sử dụng

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
7

Thông số
  • usagePlanId [chuỗi] --

    [CẦN THIẾT]

    Id của tài nguyên UsagePlan đại diện cho gói sử dụng có chứa tài nguyên UsagePlanKey sắp được tạo đại diện cho một khách hàng sử dụng gói

  • keyId [chuỗi] --

    [CẦN THIẾT]

    Mã định danh của tài nguyên UsagePlanKey cho khách hàng gói

  • keyType [chuỗi] --

    [CẦN THIẾT]

    Loại tài nguyên UsagePlanKey cho khách hàng gói

loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
8

Cấu trúc phản hồi

  • [chính tả] --

    Đại diện cho khóa gói sử dụng để xác định khách hàng gói

    • id [chuỗi] --

      Id của khóa kế hoạch sử dụng

    • loại [chuỗi] --

      Loại khóa kế hoạch sử dụng. Hiện tại, loại khóa hợp lệ là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2440

    • giá trị [chuỗi] --

      Giá trị của khóa kế hoạch sử dụng

    • tên [chuỗi] --

      Tên của khóa kế hoạch sử dụng

ngoại lệ

  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2909
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2910
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2911
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2912
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2913
  • {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2914
{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
2447 [ **kwargs ]

Tạo một liên kết VPC, trong tài khoản của người gọi ở một khu vực đã chọn, trong một hoạt động không đồng bộ thường mất 2-4 phút để hoàn thành và đi vào hoạt động. Người gọi phải có quyền tạo và cập nhật các dịch vụ VPC Endpoint

Xem thêm. Tài liệu API AWS

Cú pháp yêu cầu

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
9

Thông số
  • tên [chuỗi] --

    [CẦN THIẾT]

    Tên được sử dụng để gắn nhãn và xác định liên kết VPC

  • description [string] -- Mô tả của liên kết VPC
  • targetArns [danh sách] --

    [CẦN THIẾT]

    ARN của bộ cân bằng tải mạng của VPC được nhắm mục tiêu bởi liên kết VPC. Bộ cân bằng tải mạng phải được sở hữu bởi cùng một tài khoản AWS của chủ sở hữu API

    • [chuỗi] --
  • thẻ [dict] --

    Bản đồ khóa-giá trị của chuỗi. Bộ ký tự hợp lệ là [a-zA-Z+-=. _. /]. Khóa thẻ có thể dài tối đa 128 ký tự và không được bắt đầu bằng

    {
        'id': 'string',
        'value': 'string',
        'name': 'string',
        'customerId': 'string',
        'description': 'string',
        'enabled': True|False,
        'createdDate': datetime[2015, 1, 1],
        'lastUpdatedDate': datetime[2015, 1, 1],
        'stageKeys': [
            'string',
        ],
        'tags': {
            'string': 'string'
        }
    }
    
    2908. Giá trị thẻ có thể lên tới 256 ký tự

    • [chuỗi] --
      • [chuỗi] --
loại trả lại

mệnh lệnh

trả lại

Cú pháp phản hồi

{
    'id': 'string',
    'value': 'string',
    'name': 'string',
    'customerId': 'string',
    'description': 'string',
    'enabled': True|False,
    'createdDate': datetime[2015, 1, 1],
    'lastUpdatedDate': datetime[2015, 1, 1],
    'stageKeys': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}
90

Cấu trúc phản hồi

  • [chính tả] --

    Liên kết API Gateway VPC cho RestApi để truy cập tài nguyên trong Amazon Virtual Private Cloud [VPC]

    • id [chuỗi] --

      Định danh của VpcLink. Nó được sử dụng trong Tích hợp để tham chiếu VpcLink này

    • tên [chuỗi] --

      Tên được sử dụng để gắn nhãn và xác định liên kết VPC

    • mô tả [chuỗi] --

      Mô tả của liên kết VPC

    • targetArns [danh sách] --

      ARN của bộ cân bằng tải mạng của VPC được nhắm mục tiêu bởi liên kết VPC. Bộ cân bằng tải mạng phải được sở hữu bởi cùng một tài khoản AWS của chủ sở hữu API

      • [chuỗi] --
    • trạng thái [chuỗi] --

      Trạng thái của liên kết VPC. Các giá trị hợp lệ là

      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      1445 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2450 ,
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2451 hoặc
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2452. Triển khai API sẽ đợi nếu trạng thái là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2450 và sẽ thất bại nếu trạng thái là
      {
          'id': 'string',
          'value': 'string',
          'name': 'string',
          'customerId': 'string',
          'description': 'string',
          'enabled': True|False,
          'createdDate': datetime[2015, 1, 1],
          'lastUpdatedDate': datetime[2015, 1, 1],
          'stageKeys': [
              'string',
          ],
          'tags': {
              'string': 'string'
          }
      }
      
      2451

      Cổng API trong Python là gì?

      Cổng API cho phép nhà phát triển kết nối an toàn các ứng dụng web và di động với API chạy trên AWS Lambda, Amazon EC2 hoặc các dịch vụ web có địa chỉ công khai khác được lưu trữ bên ngoài AWS. client['apigateway']

      Làm cách nào để tạo API bằng Python với Lambda?

      Hướng dẫn. Sử dụng Lambda với API Gateway .
      Tạo và định cấu hình hàm Lambda bằng Python hoặc Node. .
      Tạo API REST trong Cổng API để kết nối với chức năng Lambda của bạn
      Tạo bảng DynamoDB và kiểm tra bảng đó bằng chức năng Lambda của bạn trong bảng điều khiển
      Triển khai API của bạn và kiểm tra thiết lập đầy đủ bằng cách sử dụng curl trong thiết bị đầu cuối

      Làm cách nào để gọi cổng API từ Lambda Python?

      Thêm điểm cuối vào hàm Lambda của bạn .
      Mở trang Chức năng của bảng điều khiển Lambda
      Chọn một chức năng
      Trong phần Tổng quan về chức năng, hãy chọn Thêm trình kích hoạt
      Select API Gateway
      Choose Create an API or Use an existing API. New API. For API type, choose HTTP API. .
      For Security, choose Open
      Chọn Thêm

      Is flask an API gateway?

      What we have is a Flask application that is deployed with a serverless framework, which runs in an AWS Lambda behind Amazon API Gateway . Authentication is handled by a second Lambda, an API Gateway authorizer, which issues and validates OAuth2 tokens.

Chủ Đề